#include <PrismaticJointSpecificationRecord.h>

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

Public Member Functions
	PrismaticJointSpecificationRecord ()

	PrismaticJointSpecificationRecord (const PrismaticJointSpecificationRecord &source)

	~PrismaticJointSpecificationRecord ()

void	copy (PrismaticJointSpecificationRecord &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	isPrismaticJointMaxSpeedEnabled (void) const

void	enablePrismaticJointMaxSpeed (void)

void	disablePrismaticJointMaxSpeed (void)

bool	isPrismaticJointMaxForceEnabled (void) const

void	enablePrismaticJointMaxForce (void)

void	disablePrismaticJointMaxForce (void)

double	getLinkLength_m (void)

bool	setLinkLength_m (double value)

double	getTwistAngle_rad (void)

bool	setTwistAngle_rad (double value)

double	getJointAngle_rad (void)

bool	setJointAngle_rad (double value)

double	getPrismaticJointMinValue_m (void)

bool	setPrismaticJointMinValue_m (double value)

double	getPrismaticJointMaxValue_m (void)

bool	setPrismaticJointMaxValue_m (double value)

double	getPrismaticJointMaxSpeed_mps (void)

bool	setPrismaticJointMaxSpeed_mps (double value)

double	getPrismaticJointMaxForce_N (void)

bool	setPrismaticJointMaxForce_N (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_PRISMATICJOINTMAXSPEED = 0x1

static const uint8_t	PV_PRISMATICJOINTMAXFORCE = 0x2

static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS \| PV_PRISMATICJOINTMAXSPEED \| PV_PRISMATICJOINTMAXFORCE

Protected Attributes
LinkLengthScaledInteger	linkLength_m

TwistAngleScaledInteger	twistAngle_rad

JointAngleScaledInteger	jointAngle_rad

PrismaticJointMinValueScaledInteger	prismaticJointMinValue_m

PrismaticJointMaxValueScaledInteger	prismaticJointMaxValue_m

PrismaticJointMaxSpeedScaledInteger	prismaticJointMaxSpeed_mps

PrismaticJointMaxForceScaledInteger	prismaticJointMaxForce_N

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

◆ PrismaticJointSpecificationRecord() [1/2]

openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::PrismaticJointSpecificationRecord ( )

◆ PrismaticJointSpecificationRecord() [2/2]

openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::PrismaticJointSpecificationRecord ( const PrismaticJointSpecificationRecord & source )

◆ ~PrismaticJointSpecificationRecord()

openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::~PrismaticJointSpecificationRecord ( )

Member Function Documentation

◆ copy()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::copy ( PrismaticJointSpecificationRecord & source )

◆ disablePrismaticJointMaxForce()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::disablePrismaticJointMaxForce ( void )

◆ disablePrismaticJointMaxSpeed()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::disablePrismaticJointMaxSpeed ( void )

◆ enablePrismaticJointMaxForce()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::enablePrismaticJointMaxForce ( void )

◆ enablePrismaticJointMaxSpeed()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::enablePrismaticJointMaxSpeed ( void )

◆ from()

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

◆ getJointAngle_rad()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getJointAngle_rad ( void )

◆ getLinkLength_m()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getLinkLength_m ( void )

◆ getPresenceVector()

uint8_t openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getPresenceVector ( void ) const

◆ getPrismaticJointMaxForce_N()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getPrismaticJointMaxForce_N ( void )

◆ getPrismaticJointMaxSpeed_mps()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getPrismaticJointMaxSpeed_mps ( void )

◆ getPrismaticJointMaxValue_m()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getPrismaticJointMaxValue_m ( void )

◆ getPrismaticJointMinValue_m()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getPrismaticJointMinValue_m ( void )

◆ getTwistAngle_rad()

double openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::getTwistAngle_rad ( void )

◆ isPrismaticJointMaxForceEnabled()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::isPrismaticJointMaxForceEnabled ( void ) const

◆ isPrismaticJointMaxSpeedEnabled()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::isPrismaticJointMaxSpeedEnabled ( void ) const

◆ length()

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

virtual

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

◆ setJointAngle_rad()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setJointAngle_rad ( double value )

◆ setLinkLength_m()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setLinkLength_m ( double value )

◆ setPresenceVector()

void openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setPresenceVector ( uint8_t value )

◆ setPrismaticJointMaxForce_N()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setPrismaticJointMaxForce_N ( double value )

◆ setPrismaticJointMaxSpeed_mps()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setPrismaticJointMaxSpeed_mps ( double value )

◆ setPrismaticJointMaxValue_m()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setPrismaticJointMaxValue_m ( double value )

◆ setPrismaticJointMinValue_m()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setPrismaticJointMinValue_m ( double value )

◆ setTwistAngle_rad()

bool openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::setTwistAngle_rad ( double value )

◆ to()

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

Member Data Documentation

◆ jointAngle_rad

JointAngleScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::jointAngle_rad

protected

◆ linkLength_m

LinkLengthScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::linkLength_m

protected

◆ presenceVector

uint8_t openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::presenceVector

protected

◆ prismaticJointMaxForce_N

PrismaticJointMaxForceScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::prismaticJointMaxForce_N

protected

◆ prismaticJointMaxSpeed_mps

PrismaticJointMaxSpeedScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::prismaticJointMaxSpeed_mps

protected

◆ prismaticJointMaxValue_m

PrismaticJointMaxValueScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::prismaticJointMaxValue_m

protected

◆ prismaticJointMinValue_m

PrismaticJointMinValueScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::prismaticJointMinValue_m

protected

◆ PV_ALL_FIELDS

const uint8_t openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_PRISMATICJOINTMAXSPEED | PV_PRISMATICJOINTMAXFORCE

static

◆ PV_NO_FIELDS

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

static

◆ PV_PRISMATICJOINTMAXFORCE

const uint8_t openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::PV_PRISMATICJOINTMAXFORCE = 0x2

static

◆ PV_PRISMATICJOINTMAXSPEED

const uint8_t openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::PV_PRISMATICJOINTMAXSPEED = 0x1

static

◆ twistAngle_rad

TwistAngleScaledInteger openjaus::manipulator_v1_0::PrismaticJointSpecificationRecord::twistAngle_rad

protected

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

include/openjaus/manipulator_v1_0/Triggers/Fields/PrismaticJointSpecificationRecord.h
src/openjaus/manipulator_v1_0/Triggers/Fields/PrismaticJointSpecificationRecord.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

◆ PrismaticJointSpecificationRecord() [1/2]

◆ PrismaticJointSpecificationRecord() [2/2]

◆ ~PrismaticJointSpecificationRecord()

Member Function Documentation

◆ copy()

◆ disablePrismaticJointMaxForce()

◆ disablePrismaticJointMaxSpeed()

◆ enablePrismaticJointMaxForce()

◆ enablePrismaticJointMaxSpeed()

◆ from()

◆ getJointAngle_rad()

◆ getLinkLength_m()

◆ getPresenceVector()

◆ getPrismaticJointMaxForce_N()

◆ getPrismaticJointMaxSpeed_mps()

◆ getPrismaticJointMaxValue_m()

◆ getPrismaticJointMinValue_m()

◆ getTwistAngle_rad()

◆ isPrismaticJointMaxForceEnabled()

◆ isPrismaticJointMaxSpeedEnabled()

◆ length()

◆ setJointAngle_rad()

◆ setLinkLength_m()

◆ setPresenceVector()

◆ setPrismaticJointMaxForce_N()

◆ setPrismaticJointMaxSpeed_mps()

◆ setPrismaticJointMaxValue_m()

◆ setPrismaticJointMinValue_m()

◆ setTwistAngle_rad()

◆ to()

◆ toXml()

Member Data Documentation

◆ jointAngle_rad

◆ linkLength_m

◆ presenceVector

◆ prismaticJointMaxForce_N

◆ prismaticJointMaxSpeed_mps

◆ prismaticJointMaxValue_m

◆ prismaticJointMinValue_m

◆ PV_ALL_FIELDS

◆ PV_NO_FIELDS

◆ PV_PRISMATICJOINTMAXFORCE

◆ PV_PRISMATICJOINTMAXSPEED

◆ twistAngle_rad