OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
openjaus::ugv_v1_0::DieselEngineConfigurationRecord Class Reference

#include <DieselEngineConfigurationRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions

 DieselEngineConfigurationRecord ()
 
 DieselEngineConfigurationRecord (const DieselEngineConfigurationRecord &source)
 
 ~DieselEngineConfigurationRecord ()
 
void copy (DieselEngineConfigurationRecord &source)
 
virtual uint64 to (system::BufferWriter &dst) const
 Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...
 
virtual uint64 from (system::BufferReader &src)
 Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...
 
virtual uint64 length (void) const
 Gets the serialized length of this object. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
void setPresenceVector (uint8_t value)
 
uint8_t getPresenceVector (void) const
 
bool isRpmEnabled (void) const
 
void enableRpm (void)
 
void disableRpm (void)
 
bool isThrottleEnabled (void) const
 
void enableThrottle (void)
 
void disableThrottle (void)
 
bool isPlugStateEnabled (void) const
 
void enablePlugState (void)
 
void disablePlugState (void)
 
PowerStateEnumeration::PowerStateEnum getPowerState (void)
 
bool setPowerState (PowerStateEnumeration::PowerStateEnum value)
 
std::string getPowerStateToString (void)
 
uint16_t getRpm (void)
 
bool setRpm (uint16_t value)
 
double getThrottle (void)
 
bool setThrottle (double value)
 
PlugStateEnumeration::PlugStateEnum getPlugState (void)
 
bool setPlugState (PlugStateEnumeration::PlugStateEnum value)
 
std::string getPlugStateToString (void)
 
- Public Member Functions inherited from openjaus::model::fields::Record
 Record ()
 
virtual ~Record ()
 
const std::vector< Field *> & getFields () const
 Accessor to get the value of fields. More...
 
bool setFields (const Field &fields)
 Accessor to set value of fields. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual ~ComplexField ()
 
- Public Member Functions inherited from openjaus::model::fields::Field
 Field ()
 
virtual ~Field ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

static const uint8_t PV_NO_FIELDS = 0x0
 
static const uint8_t PV_RPM = 0x1
 
static const uint8_t PV_THROTTLE = 0x2
 
static const uint8_t PV_PLUGSTATE = 0x4
 
static const uint8_t PV_ALL_FIELDS = PV_NO_FIELDS | PV_RPM | PV_THROTTLE | PV_PLUGSTATE
 

Protected Attributes

PowerStateEnumeration powerState
 
model::fields::UnsignedShort rpm
 
ThrottleScaledInteger throttle
 
PlugStateEnumeration plugState
 
uint8_t presenceVector
 
- Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *> fields
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Constructor & Destructor Documentation

◆ DieselEngineConfigurationRecord() [1/2]

openjaus::ugv_v1_0::DieselEngineConfigurationRecord::DieselEngineConfigurationRecord ( )

◆ DieselEngineConfigurationRecord() [2/2]

openjaus::ugv_v1_0::DieselEngineConfigurationRecord::DieselEngineConfigurationRecord ( const DieselEngineConfigurationRecord source)

◆ ~DieselEngineConfigurationRecord()

openjaus::ugv_v1_0::DieselEngineConfigurationRecord::~DieselEngineConfigurationRecord ( )

Member Function Documentation

◆ copy()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::copy ( DieselEngineConfigurationRecord source)

◆ disablePlugState()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::disablePlugState ( void  )

◆ disableRpm()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::disableRpm ( void  )

◆ disableThrottle()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::disableThrottle ( void  )

◆ enablePlugState()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::enablePlugState ( void  )

◆ enableRpm()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::enableRpm ( void  )

◆ enableThrottle()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::enableThrottle ( void  )

◆ from()

uint64 openjaus::ugv_v1_0::DieselEngineConfigurationRecord::from ( system::BufferReader src)
virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters
src

Reimplemented from openjaus::model::fields::Record.

◆ getPlugState()

PlugStateEnumeration::PlugStateEnum openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getPlugState ( void  )

◆ getPlugStateToString()

std::string openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getPlugStateToString ( void  )

◆ getPowerState()

PowerStateEnumeration::PowerStateEnum openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getPowerState ( void  )

◆ getPowerStateToString()

std::string openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getPowerStateToString ( void  )

◆ getPresenceVector()

uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getPresenceVector ( void  ) const

◆ getRpm()

uint16_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getRpm ( void  )

◆ getThrottle()

double openjaus::ugv_v1_0::DieselEngineConfigurationRecord::getThrottle ( void  )

◆ isPlugStateEnabled()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::isPlugStateEnabled ( void  ) const

◆ isRpmEnabled()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::isRpmEnabled ( void  ) const

◆ isThrottleEnabled()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::isThrottleEnabled ( void  ) const

◆ length()

uint64 openjaus::ugv_v1_0::DieselEngineConfigurationRecord::length ( void  ) const
virtual

Reimplemented from openjaus::model::fields::Record.

◆ setPlugState()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::setPlugState ( PlugStateEnumeration::PlugStateEnum  value)

◆ setPowerState()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::setPowerState ( PowerStateEnumeration::PowerStateEnum  value)

◆ setPresenceVector()

void openjaus::ugv_v1_0::DieselEngineConfigurationRecord::setPresenceVector ( uint8_t  value)

◆ setRpm()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::setRpm ( uint16_t  value)

◆ setThrottle()

bool openjaus::ugv_v1_0::DieselEngineConfigurationRecord::setThrottle ( double  value)

◆ to()

uint64 openjaus::ugv_v1_0::DieselEngineConfigurationRecord::to ( system::BufferWriter dst) const
virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters
dst

Reimplemented from openjaus::model::fields::Record.

◆ toXml()

std::string openjaus::ugv_v1_0::DieselEngineConfigurationRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ plugState

PlugStateEnumeration openjaus::ugv_v1_0::DieselEngineConfigurationRecord::plugState
protected

◆ powerState

PowerStateEnumeration openjaus::ugv_v1_0::DieselEngineConfigurationRecord::powerState
protected

◆ presenceVector

uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::presenceVector
protected

◆ PV_ALL_FIELDS

const uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_RPM | PV_THROTTLE | PV_PLUGSTATE
static

◆ PV_NO_FIELDS

const uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::PV_NO_FIELDS = 0x0
static

◆ PV_PLUGSTATE

const uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::PV_PLUGSTATE = 0x4
static

◆ PV_RPM

const uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::PV_RPM = 0x1
static

◆ PV_THROTTLE

const uint8_t openjaus::ugv_v1_0::DieselEngineConfigurationRecord::PV_THROTTLE = 0x2
static

◆ rpm

model::fields::UnsignedShort openjaus::ugv_v1_0::DieselEngineConfigurationRecord::rpm
protected

◆ throttle

ThrottleScaledInteger openjaus::ugv_v1_0::DieselEngineConfigurationRecord::throttle
protected

The documentation for this class was generated from the following files: