openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord Class Reference

#include <RevoluteJointSpecificationRecord.h>

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

Public Member Functions
	RevoluteJointSpecificationRecord ()
	RevoluteJointSpecificationRecord (const RevoluteJointSpecificationRecord &source)
	~RevoluteJointSpecificationRecord ()
void	copy (RevoluteJointSpecificationRecord &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	isRevoluteJointMinValueEnabled (void) const
void	enableRevoluteJointMinValue (void)
void	disableRevoluteJointMinValue (void)
bool	isRevoluteJointMaxValueEnabled (void) const
void	enableRevoluteJointMaxValue (void)
void	disableRevoluteJointMaxValue (void)
bool	isRevoluteJointMaxSpeedEnabled (void) const
void	enableRevoluteJointMaxSpeed (void)
void	disableRevoluteJointMaxSpeed (void)
bool	isRevoluteJointMaxTorqueEnabled (void) const
void	enableRevoluteJointMaxTorque (void)
void	disableRevoluteJointMaxTorque (void)
double	getLinkLength_m (void)
bool	setLinkLength_m (double value)
double	getTwistAngle_rad (void)
bool	setTwistAngle_rad (double value)
double	getJointOffset_m (void)
bool	setJointOffset_m (double value)
double	getRevoluteJointMinValue_rad (void)
bool	setRevoluteJointMinValue_rad (double value)
double	getRevoluteJointMaxValue_rad (void)
bool	setRevoluteJointMaxValue_rad (double value)
double	getRevoluteJointMaxSpeed_rps (void)
bool	setRevoluteJointMaxSpeed_rps (double value)
double	getRevoluteJointMaxTorque_Nm (void)
bool	setRevoluteJointMaxTorque_Nm (double value)
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_REVOLUTEJOINTMINVALUE = 0x1
static const uint8_t	PV_REVOLUTEJOINTMAXVALUE = 0x2
static const uint8_t	PV_REVOLUTEJOINTMAXSPEED = 0x4
static const uint8_t	PV_REVOLUTEJOINTMAXTORQUE = 0x8
static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS | PV_REVOLUTEJOINTMINVALUE | PV_REVOLUTEJOINTMAXVALUE | PV_REVOLUTEJOINTMAXSPEED | PV_REVOLUTEJOINTMAXTORQUE

Protected Attributes
LinkLengthScaledInteger	linkLength_m
TwistAngleScaledInteger	twistAngle_rad
JointOffsetScaledInteger	jointOffset_m
RevoluteJointMinValueScaledInteger	revoluteJointMinValue_rad
RevoluteJointMaxValueScaledInteger	revoluteJointMaxValue_rad
RevoluteJointMaxSpeedScaledInteger	revoluteJointMaxSpeed_rps
RevoluteJointMaxTorqueScaledInteger	revoluteJointMaxTorque_Nm
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

RevoluteJointSpecificationRecord() [1/2]

openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::RevoluteJointSpecificationRecord

(

)

RevoluteJointSpecificationRecord() [2/2]

openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::RevoluteJointSpecificationRecord

(

const RevoluteJointSpecificationRecord &

source

)

~RevoluteJointSpecificationRecord()

openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::~RevoluteJointSpecificationRecord

(

)

Member Function Documentation

copy()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::copy

(

RevoluteJointSpecificationRecord &

source

)

disableRevoluteJointMaxSpeed()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::disableRevoluteJointMaxSpeed

(

void

)

disableRevoluteJointMaxTorque()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::disableRevoluteJointMaxTorque

(

void

)

disableRevoluteJointMaxValue()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::disableRevoluteJointMaxValue

(

void

)

disableRevoluteJointMinValue()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::disableRevoluteJointMinValue

(

void

)

enableRevoluteJointMaxSpeed()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::enableRevoluteJointMaxSpeed

(

void

)

enableRevoluteJointMaxTorque()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::enableRevoluteJointMaxTorque

(

void

)

enableRevoluteJointMaxValue()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::enableRevoluteJointMaxValue

(

void

)

enableRevoluteJointMinValue()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::enableRevoluteJointMinValue

(

void

)

from()

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

getJointOffset_m()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getJointOffset_m

(

void

)

getLinkLength_m()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getLinkLength_m

(

void

)

getPresenceVector()

uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getPresenceVector

(

void

)

const

getRevoluteJointMaxSpeed_rps()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getRevoluteJointMaxSpeed_rps

(

void

)

getRevoluteJointMaxTorque_Nm()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getRevoluteJointMaxTorque_Nm

(

void

)

getRevoluteJointMaxValue_rad()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getRevoluteJointMaxValue_rad

(

void

)

getRevoluteJointMinValue_rad()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getRevoluteJointMinValue_rad

(

void

)

getTwistAngle_rad()

double openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::getTwistAngle_rad

(

void

)

isRevoluteJointMaxSpeedEnabled()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::isRevoluteJointMaxSpeedEnabled

(

void

)

const

isRevoluteJointMaxTorqueEnabled()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::isRevoluteJointMaxTorqueEnabled

(

void

)

const

isRevoluteJointMaxValueEnabled()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::isRevoluteJointMaxValueEnabled

(

void

)

const

isRevoluteJointMinValueEnabled()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::isRevoluteJointMinValueEnabled

(

void

)

const

length()

uint64 openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::length ( void  ) const

virtual

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

setJointOffset_m()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setJointOffset_m

(

double

value

)

setLinkLength_m()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setLinkLength_m

(

double

value

)

setPresenceVector()

void openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setPresenceVector

(

uint8_t

value

)

setRevoluteJointMaxSpeed_rps()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setRevoluteJointMaxSpeed_rps

(

double

value

)

setRevoluteJointMaxTorque_Nm()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setRevoluteJointMaxTorque_Nm

(

double

value

)

setRevoluteJointMaxValue_rad()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setRevoluteJointMaxValue_rad

(

double

value

)

setRevoluteJointMinValue_rad()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setRevoluteJointMinValue_rad

(

double

value

)

setTwistAngle_rad()

bool openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::setTwistAngle_rad

(

double

value

)

to()

uint64 openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::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::manipulator_v1_0::RevoluteJointSpecificationRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

jointOffset_m

JointOffsetScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::jointOffset_m

protected

linkLength_m

LinkLengthScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::linkLength_m

protected

presenceVector

uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_REVOLUTEJOINTMINVALUE | PV_REVOLUTEJOINTMAXVALUE | PV_REVOLUTEJOINTMAXSPEED | PV_REVOLUTEJOINTMAXTORQUE

static

PV_NO_FIELDS

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_NO_FIELDS = 0x0

static

PV_REVOLUTEJOINTMAXSPEED

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_REVOLUTEJOINTMAXSPEED = 0x4

static

PV_REVOLUTEJOINTMAXTORQUE

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_REVOLUTEJOINTMAXTORQUE = 0x8

static

PV_REVOLUTEJOINTMAXVALUE

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_REVOLUTEJOINTMAXVALUE = 0x2

static

PV_REVOLUTEJOINTMINVALUE

const uint8_t openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::PV_REVOLUTEJOINTMINVALUE = 0x1

static

revoluteJointMaxSpeed_rps

RevoluteJointMaxSpeedScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::revoluteJointMaxSpeed_rps

protected

revoluteJointMaxTorque_Nm

RevoluteJointMaxTorqueScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::revoluteJointMaxTorque_Nm

protected

revoluteJointMaxValue_rad

RevoluteJointMaxValueScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::revoluteJointMaxValue_rad

protected

revoluteJointMinValue_rad

RevoluteJointMinValueScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::revoluteJointMinValue_rad

protected

twistAngle_rad

TwistAngleScaledInteger openjaus::manipulator_v1_0::RevoluteJointSpecificationRecord::twistAngle_rad

protected

---

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

• include/openjaus/manipulator_v1_0/Triggers/Fields/RevoluteJointSpecificationRecord.h
• src/openjaus/manipulator_v1_0/Triggers/Fields/RevoluteJointSpecificationRecord.cpp