openjaus::manipulator::PrismaticJointSpecificationRecord Class Reference

#include <PrismaticJointSpecificationRecord.h>

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

Public Member Functions
	PrismaticJointSpecificationRecord ()
	PrismaticJointSpecificationRecord (const PrismaticJointSpecificationRecord &source)
	~PrismaticJointSpecificationRecord ()
void	copy (PrismaticJointSpecificationRecord &source)
virtual int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length (void)
	Serializes object to internal transport buffer. 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
virtual	~Transportable ()
	Transportable ()

Static Public Attributes
static const uint8_t	PV_ALL_FIELDS = 0xFF
static const uint8_t	PV_NO_FIELDS = 0x0
static const uint8_t	PV_PRISMATICJOINTMAXSPEED = 0x1
static const uint8_t	PV_PRISMATICJOINTMAXFORCE = 0x2

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::PrismaticJointSpecificationRecord::PrismaticJointSpecificationRecord

(

)

PrismaticJointSpecificationRecord() [2/2]

openjaus::manipulator::PrismaticJointSpecificationRecord::PrismaticJointSpecificationRecord

(

const PrismaticJointSpecificationRecord &

source

)

~PrismaticJointSpecificationRecord()

openjaus::manipulator::PrismaticJointSpecificationRecord::~PrismaticJointSpecificationRecord

(

)

Member Function Documentation

copy()

void openjaus::manipulator::PrismaticJointSpecificationRecord::copy

(

PrismaticJointSpecificationRecord &

source

)

disablePrismaticJointMaxForce()

void openjaus::manipulator::PrismaticJointSpecificationRecord::disablePrismaticJointMaxForce

(

void

)

disablePrismaticJointMaxSpeed()

void openjaus::manipulator::PrismaticJointSpecificationRecord::disablePrismaticJointMaxSpeed

(

void

)

enablePrismaticJointMaxForce()

void openjaus::manipulator::PrismaticJointSpecificationRecord::enablePrismaticJointMaxForce

(

void

)

enablePrismaticJointMaxSpeed()

void openjaus::manipulator::PrismaticJointSpecificationRecord::enablePrismaticJointMaxSpeed

(

void

)

from()

int openjaus::manipulator::PrismaticJointSpecificationRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getJointAngle_rad()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getJointAngle_rad

(

void

)

getLinkLength_m()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getLinkLength_m

(

void

)

getPresenceVector()

uint8_t openjaus::manipulator::PrismaticJointSpecificationRecord::getPresenceVector

(

void

)

const

getPrismaticJointMaxForce_N()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getPrismaticJointMaxForce_N

(

void

)

getPrismaticJointMaxSpeed_mps()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getPrismaticJointMaxSpeed_mps

(

void

)

getPrismaticJointMaxValue_m()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getPrismaticJointMaxValue_m

(

void

)

getPrismaticJointMinValue_m()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getPrismaticJointMinValue_m

(

void

)

getTwistAngle_rad()

double openjaus::manipulator::PrismaticJointSpecificationRecord::getTwistAngle_rad

(

void

)

isPrismaticJointMaxForceEnabled()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::isPrismaticJointMaxForceEnabled

(

void

)

const

isPrismaticJointMaxSpeedEnabled()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::isPrismaticJointMaxSpeedEnabled

(

void

)

const

length()

int openjaus::manipulator::PrismaticJointSpecificationRecord::length ( void  )

virtual

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

setJointAngle_rad()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setJointAngle_rad

(

double

value

)

setLinkLength_m()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setLinkLength_m

(

double

value

)

setPresenceVector()

void openjaus::manipulator::PrismaticJointSpecificationRecord::setPresenceVector

(

uint8_t

value

)

setPrismaticJointMaxForce_N()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setPrismaticJointMaxForce_N

(

double

value

)

setPrismaticJointMaxSpeed_mps()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setPrismaticJointMaxSpeed_mps

(

double

value

)

setPrismaticJointMaxValue_m()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setPrismaticJointMaxValue_m

(

double

value

)

setPrismaticJointMinValue_m()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setPrismaticJointMinValue_m

(

double

value

)

setTwistAngle_rad()

bool openjaus::manipulator::PrismaticJointSpecificationRecord::setTwistAngle_rad

(

double

value

)

to()

int openjaus::manipulator::PrismaticJointSpecificationRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::manipulator::PrismaticJointSpecificationRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

jointAngle_rad

JointAngleScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::jointAngle_rad

protected

linkLength_m

LinkLengthScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::linkLength_m

protected

presenceVector

uint8_t openjaus::manipulator::PrismaticJointSpecificationRecord::presenceVector

protected

prismaticJointMaxForce_N

PrismaticJointMaxForceScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::prismaticJointMaxForce_N

protected

prismaticJointMaxSpeed_mps

PrismaticJointMaxSpeedScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::prismaticJointMaxSpeed_mps

protected

prismaticJointMaxValue_m

PrismaticJointMaxValueScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::prismaticJointMaxValue_m

protected

prismaticJointMinValue_m

PrismaticJointMinValueScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::prismaticJointMinValue_m

protected

PV_ALL_FIELDS

const uint8_t openjaus::manipulator::PrismaticJointSpecificationRecord::PV_ALL_FIELDS = 0xFF

static

PV_NO_FIELDS

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

static

PV_PRISMATICJOINTMAXFORCE

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

static

PV_PRISMATICJOINTMAXSPEED

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

static

twistAngle_rad

TwistAngleScaledInteger openjaus::manipulator::PrismaticJointSpecificationRecord::twistAngle_rad

protected

---

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

• include/openjaus/manipulator/Triggers/Fields/PrismaticJointSpecificationRecord.h
• src/openjaus/manipulator/Triggers/Fields/PrismaticJointSpecificationRecord.cpp