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

#include <JointForceTorqueVariant.h>

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

Public Types

enum  TypeEnum { JOINTFORCETORQUEOPTION0 = 1, JOINTFORCETORQUEOPTION1 = 2 }
 

Public Member Functions

 JointForceTorqueVariant ()
 
 ~JointForceTorqueVariant ()
 
JointForceTorqueVariant::TypeEnum getType (void)
 
void setType (JointForceTorqueVariant::TypeEnum type)
 
void copy (JointForceTorqueVariant &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
 
double getJointForceTorqueOption0_Nm (void)
 
bool setJointForceTorqueOption0_Nm (double value)
 
double getJointForceTorqueOption1_N (void)
 
bool setJointForceTorqueOption1_N (double value)
 
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
 
JointForceTorqueOption0ScaledInteger jointForceTorqueOption0_Nm
 
JointForceTorqueOption1ScaledInteger jointForceTorqueOption1_N
 

Additional Inherited Members

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

Member Enumeration Documentation

◆ TypeEnum

Enumerator
JOINTFORCETORQUEOPTION0 
JOINTFORCETORQUEOPTION1 

Constructor & Destructor Documentation

◆ JointForceTorqueVariant()

openjaus::manipulator_v1_0::JointForceTorqueVariant::JointForceTorqueVariant ( )

◆ ~JointForceTorqueVariant()

openjaus::manipulator_v1_0::JointForceTorqueVariant::~JointForceTorqueVariant ( )

Member Function Documentation

◆ copy()

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

◆ from()

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

◆ getJointForceTorqueOption0_Nm()

double openjaus::manipulator_v1_0::JointForceTorqueVariant::getJointForceTorqueOption0_Nm ( void  )

◆ getJointForceTorqueOption1_N()

double openjaus::manipulator_v1_0::JointForceTorqueVariant::getJointForceTorqueOption1_N ( void  )

◆ getType()

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

◆ length()

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

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

◆ setJointForceTorqueOption0_Nm()

bool openjaus::manipulator_v1_0::JointForceTorqueVariant::setJointForceTorqueOption0_Nm ( double  value)

◆ setJointForceTorqueOption1_N()

bool openjaus::manipulator_v1_0::JointForceTorqueVariant::setJointForceTorqueOption1_N ( double  value)

◆ setType()

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

◆ to()

uint64 openjaus::manipulator_v1_0::JointForceTorqueVariant::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::JointForceTorqueVariant::toXml ( unsigned char  ojIndentLevel = 0) const

◆ typeToString()

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

Member Data Documentation

◆ jointForceTorqueOption0_Nm

JointForceTorqueOption0ScaledInteger openjaus::manipulator_v1_0::JointForceTorqueVariant::jointForceTorqueOption0_Nm
private

◆ jointForceTorqueOption1_N

JointForceTorqueOption1ScaledInteger openjaus::manipulator_v1_0::JointForceTorqueVariant::jointForceTorqueOption1_N
private

◆ type

TypeEnum openjaus::manipulator_v1_0::JointForceTorqueVariant::type
private

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