OpenJAUS SAE SDK  6.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
openjaus::mobility_v1_0::VelocityCommandTypeEnumeration Class Reference

#include <VelocityCommandTypeEnumeration.h>

Inherits openjaus::model::fields::Enumeration.

Public Types

enum  VelocityCommandTypeEnum { CURRENT = 0, MAXIMUM = 1, MINIMUM = 2, DEFAULT = 3 }
 

Public Member Functions

 VelocityCommandTypeEnumeration ()
 
 VelocityCommandTypeEnumeration (VelocityCommandTypeEnum value)
 
 ~VelocityCommandTypeEnumeration ()
 
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
 
std::string toString () const
 
VelocityCommandTypeEnum getValue (void) const
 
void setValue (VelocityCommandTypeEnum value)
 
- Public Member Functions inherited from openjaus::model::fields::Enumeration
 Enumeration ()
 
virtual ~Enumeration ()
 
long getValue () const
 Accessor to get the value of value. More...
 
bool setValue (long value)
 Accessor to set value of value. More...
 
- 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 Member Functions

static std::string toString (VelocityCommandTypeEnum value)
 

Protected Attributes

VelocityCommandTypeEnum value
 
- Protected Attributes inherited from openjaus::model::fields::Enumeration
long value
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Member Enumeration Documentation

◆ VelocityCommandTypeEnum

Enumerator
CURRENT 
MAXIMUM 
MINIMUM 
DEFAULT 

Constructor & Destructor Documentation

◆ VelocityCommandTypeEnumeration() [1/2]

openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::VelocityCommandTypeEnumeration ( )

◆ VelocityCommandTypeEnumeration() [2/2]

openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::VelocityCommandTypeEnumeration ( VelocityCommandTypeEnumeration::VelocityCommandTypeEnum  value)

◆ ~VelocityCommandTypeEnumeration()

openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::~VelocityCommandTypeEnumeration ( )

Member Function Documentation

◆ from()

uint64 openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::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::Enumeration.

◆ getValue()

VelocityCommandTypeEnumeration::VelocityCommandTypeEnum openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::getValue ( void  ) const

◆ length()

uint64 openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::length ( void  ) const
virtual

◆ setValue()

void openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::setValue ( VelocityCommandTypeEnumeration::VelocityCommandTypeEnum  value)

◆ to()

uint64 openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::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::Enumeration.

◆ toString() [1/2]

std::string openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::toString ( ) const
virtual

◆ toString() [2/2]

std::string openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::toString ( VelocityCommandTypeEnumeration::VelocityCommandTypeEnum  value)
static

◆ toXml()

std::string openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ value

VelocityCommandTypeEnum openjaus::mobility_v1_0::VelocityCommandTypeEnumeration::value
protected

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