OpenJAUS SAE SDK  6.0.0
Public Types | Public Member Functions | Private Attributes | List of all members
openjaus::manipulator_v1_0::JointSpecificationsVariant Class Reference

#include <JointSpecificationsVariant.h>

Inherits openjaus::model::fields::Variant.

Public Types

enum  TypeEnum { REVOLUTEJOINTSPECIFICATIONREC = 0, PRISMATICJOINTSPECIFICATIONREC = 1 }
 

Public Member Functions

 JointSpecificationsVariant ()
 
 ~JointSpecificationsVariant ()
 
JointSpecificationsVariant::TypeEnum getType (void)
 
void setType (JointSpecificationsVariant::TypeEnum type)
 
void copy (JointSpecificationsVariant &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
 
RevoluteJointSpecificationRecordgetRevoluteJointSpecificationRec (void)
 
PrismaticJointSpecificationRecordgetPrismaticJointSpecificationRec (void)
 
std::string typeToString (void)
 
- Public Member Functions inherited from openjaus::model::fields::Variant
 Variant ()
 
virtual ~Variant ()
 
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 ()
 

Private Attributes

TypeEnum type
 
RevoluteJointSpecificationRecord revoluteJointSpecificationRec
 
PrismaticJointSpecificationRecord prismaticJointSpecificationRec
 

Additional Inherited Members

- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Member Enumeration Documentation

◆ TypeEnum

Enumerator
REVOLUTEJOINTSPECIFICATIONREC 
PRISMATICJOINTSPECIFICATIONREC 

Constructor & Destructor Documentation

◆ JointSpecificationsVariant()

openjaus::manipulator_v1_0::JointSpecificationsVariant::JointSpecificationsVariant ( )

◆ ~JointSpecificationsVariant()

openjaus::manipulator_v1_0::JointSpecificationsVariant::~JointSpecificationsVariant ( )

Member Function Documentation

◆ copy()

void openjaus::manipulator_v1_0::JointSpecificationsVariant::copy ( JointSpecificationsVariant source)

◆ from()

uint64 openjaus::manipulator_v1_0::JointSpecificationsVariant::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::Variant.

◆ getPrismaticJointSpecificationRec()

PrismaticJointSpecificationRecord & openjaus::manipulator_v1_0::JointSpecificationsVariant::getPrismaticJointSpecificationRec ( void  )

◆ getRevoluteJointSpecificationRec()

RevoluteJointSpecificationRecord & openjaus::manipulator_v1_0::JointSpecificationsVariant::getRevoluteJointSpecificationRec ( void  )

◆ getType()

JointSpecificationsVariant::TypeEnum openjaus::manipulator_v1_0::JointSpecificationsVariant::getType ( void  )

◆ length()

uint64 openjaus::manipulator_v1_0::JointSpecificationsVariant::length ( void  ) const
virtual

Reimplemented from openjaus::model::fields::Variant.

◆ setType()

void openjaus::manipulator_v1_0::JointSpecificationsVariant::setType ( JointSpecificationsVariant::TypeEnum  type)

◆ to()

uint64 openjaus::manipulator_v1_0::JointSpecificationsVariant::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::Variant.

◆ toXml()

std::string openjaus::manipulator_v1_0::JointSpecificationsVariant::toXml ( unsigned char  ojIndentLevel = 0) const

◆ typeToString()

std::string openjaus::manipulator_v1_0::JointSpecificationsVariant::typeToString ( void  )

Member Data Documentation

◆ prismaticJointSpecificationRec

PrismaticJointSpecificationRecord openjaus::manipulator_v1_0::JointSpecificationsVariant::prismaticJointSpecificationRec
private

◆ revoluteJointSpecificationRec

RevoluteJointSpecificationRecord openjaus::manipulator_v1_0::JointSpecificationsVariant::revoluteJointSpecificationRec
private

◆ type

TypeEnum openjaus::manipulator_v1_0::JointSpecificationsVariant::type
private

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