openjaus::mobility::WrenchEffortRecord Class Reference

#include <WrenchEffortRecord.h>

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

Public Member Functions
	WrenchEffortRecord ()
	WrenchEffortRecord (const WrenchEffortRecord &source)
	~WrenchEffortRecord ()
void	copy (WrenchEffortRecord &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 (uint16_t value)
uint16_t	getPresenceVector (void) const
bool	isPropulsiveLinearEffortXEnabled (void) const
void	enablePropulsiveLinearEffortX (void)
void	disablePropulsiveLinearEffortX (void)
bool	isPropulsiveLinearEffortYEnabled (void) const
void	enablePropulsiveLinearEffortY (void)
void	disablePropulsiveLinearEffortY (void)
bool	isPropulsiveLinearEffortZEnabled (void) const
void	enablePropulsiveLinearEffortZ (void)
void	disablePropulsiveLinearEffortZ (void)
bool	isPropulsiveRotationalEffortXEnabled (void) const
void	enablePropulsiveRotationalEffortX (void)
void	disablePropulsiveRotationalEffortX (void)
bool	isPropulsiveRotationalEffortYEnabled (void) const
void	enablePropulsiveRotationalEffortY (void)
void	disablePropulsiveRotationalEffortY (void)
bool	isPropulsiveRotationalEffortZEnabled (void) const
void	enablePropulsiveRotationalEffortZ (void)
void	disablePropulsiveRotationalEffortZ (void)
bool	isResistiveLinearEffortXEnabled (void) const
void	enableResistiveLinearEffortX (void)
void	disableResistiveLinearEffortX (void)
bool	isResistiveLinearEffortYEnabled (void) const
void	enableResistiveLinearEffortY (void)
void	disableResistiveLinearEffortY (void)
bool	isResistiveLinearEffortZEnabled (void) const
void	enableResistiveLinearEffortZ (void)
void	disableResistiveLinearEffortZ (void)
bool	isResistiveRotationalEffortXEnabled (void) const
void	enableResistiveRotationalEffortX (void)
void	disableResistiveRotationalEffortX (void)
bool	isResistiveRotationalEffortYEnabled (void) const
void	enableResistiveRotationalEffortY (void)
void	disableResistiveRotationalEffortY (void)
bool	isResistiveRotationalEffortZEnabled (void) const
void	enableResistiveRotationalEffortZ (void)
void	disableResistiveRotationalEffortZ (void)
double	getPropulsiveLinearEffortX_percent (void)
bool	setPropulsiveLinearEffortX_percent (double value)
double	getPropulsiveLinearEffortY_percent (void)
bool	setPropulsiveLinearEffortY_percent (double value)
double	getPropulsiveLinearEffortZ_percent (void)
bool	setPropulsiveLinearEffortZ_percent (double value)
double	getPropulsiveRotationalEffortX_percent (void)
bool	setPropulsiveRotationalEffortX_percent (double value)
double	getPropulsiveRotationalEffortY_percent (void)
bool	setPropulsiveRotationalEffortY_percent (double value)
double	getPropulsiveRotationalEffortZ_percent (void)
bool	setPropulsiveRotationalEffortZ_percent (double value)
double	getResistiveLinearEffortX_percent (void)
bool	setResistiveLinearEffortX_percent (double value)
double	getResistiveLinearEffortY_percent (void)
bool	setResistiveLinearEffortY_percent (double value)
double	getResistiveLinearEffortZ_percent (void)
bool	setResistiveLinearEffortZ_percent (double value)
double	getResistiveRotationalEffortX_percent (void)
bool	setResistiveRotationalEffortX_percent (double value)
double	getResistiveRotationalEffortY_percent (void)
bool	setResistiveRotationalEffortY_percent (double value)
double	getResistiveRotationalEffortZ_percent (void)
bool	setResistiveRotationalEffortZ_percent (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 uint16_t	PV_ALL_FIELDS = 0xFFFF
static const uint16_t	PV_NO_FIELDS = 0x0
static const uint16_t	PV_PROPULSIVELINEAREFFORTX = 0x1
static const uint16_t	PV_PROPULSIVELINEAREFFORTY = 0x2
static const uint16_t	PV_PROPULSIVELINEAREFFORTZ = 0x4
static const uint16_t	PV_PROPULSIVEROTATIONALEFFORTX = 0x8
static const uint16_t	PV_PROPULSIVEROTATIONALEFFORTY = 0x10
static const uint16_t	PV_PROPULSIVEROTATIONALEFFORTZ = 0x20
static const uint16_t	PV_RESISTIVELINEAREFFORTX = 0x40
static const uint16_t	PV_RESISTIVELINEAREFFORTY = 0x80
static const uint16_t	PV_RESISTIVELINEAREFFORTZ = 0x100
static const uint16_t	PV_RESISTIVEROTATIONALEFFORTX = 0x200
static const uint16_t	PV_RESISTIVEROTATIONALEFFORTY = 0x400
static const uint16_t	PV_RESISTIVEROTATIONALEFFORTZ = 0x800

Protected Attributes
PropulsiveEffortScaledInteger	propulsiveLinearEffortX_percent
PropulsiveEffortScaledInteger	propulsiveLinearEffortY_percent
PropulsiveEffortScaledInteger	propulsiveLinearEffortZ_percent
PropulsiveEffortScaledInteger	propulsiveRotationalEffortX_percent
PropulsiveEffortScaledInteger	propulsiveRotationalEffortY_percent
PropulsiveEffortScaledInteger	propulsiveRotationalEffortZ_percent
ResistiveEffortScaledInteger	resistiveLinearEffortX_percent
ResistiveEffortScaledInteger	resistiveLinearEffortY_percent
ResistiveEffortScaledInteger	resistiveLinearEffortZ_percent
ResistiveEffortScaledInteger	resistiveRotationalEffortX_percent
ResistiveEffortScaledInteger	resistiveRotationalEffortY_percent
ResistiveEffortScaledInteger	resistiveRotationalEffortZ_percent
uint16_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

WrenchEffortRecord() [1/2]

openjaus::mobility::WrenchEffortRecord::WrenchEffortRecord

(

)

WrenchEffortRecord() [2/2]

openjaus::mobility::WrenchEffortRecord::WrenchEffortRecord

(

const WrenchEffortRecord &

source

)

~WrenchEffortRecord()

openjaus::mobility::WrenchEffortRecord::~WrenchEffortRecord

(

)

Member Function Documentation

copy()

void openjaus::mobility::WrenchEffortRecord::copy

(

WrenchEffortRecord &

source

)

disablePropulsiveLinearEffortX()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveLinearEffortX

(

void

)

disablePropulsiveLinearEffortY()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveLinearEffortY

(

void

)

disablePropulsiveLinearEffortZ()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveLinearEffortZ

(

void

)

disablePropulsiveRotationalEffortX()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveRotationalEffortX

(

void

)

disablePropulsiveRotationalEffortY()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveRotationalEffortY

(

void

)

disablePropulsiveRotationalEffortZ()

void openjaus::mobility::WrenchEffortRecord::disablePropulsiveRotationalEffortZ

(

void

)

disableResistiveLinearEffortX()

void openjaus::mobility::WrenchEffortRecord::disableResistiveLinearEffortX

(

void

)

disableResistiveLinearEffortY()

void openjaus::mobility::WrenchEffortRecord::disableResistiveLinearEffortY

(

void

)

disableResistiveLinearEffortZ()

void openjaus::mobility::WrenchEffortRecord::disableResistiveLinearEffortZ

(

void

)

disableResistiveRotationalEffortX()

void openjaus::mobility::WrenchEffortRecord::disableResistiveRotationalEffortX

(

void

)

disableResistiveRotationalEffortY()

void openjaus::mobility::WrenchEffortRecord::disableResistiveRotationalEffortY

(

void

)

disableResistiveRotationalEffortZ()

void openjaus::mobility::WrenchEffortRecord::disableResistiveRotationalEffortZ

(

void

)

enablePropulsiveLinearEffortX()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveLinearEffortX

(

void

)

enablePropulsiveLinearEffortY()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveLinearEffortY

(

void

)

enablePropulsiveLinearEffortZ()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveLinearEffortZ

(

void

)

enablePropulsiveRotationalEffortX()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveRotationalEffortX

(

void

)

enablePropulsiveRotationalEffortY()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveRotationalEffortY

(

void

)

enablePropulsiveRotationalEffortZ()

void openjaus::mobility::WrenchEffortRecord::enablePropulsiveRotationalEffortZ

(

void

)

enableResistiveLinearEffortX()

void openjaus::mobility::WrenchEffortRecord::enableResistiveLinearEffortX

(

void

)

enableResistiveLinearEffortY()

void openjaus::mobility::WrenchEffortRecord::enableResistiveLinearEffortY

(

void

)

enableResistiveLinearEffortZ()

void openjaus::mobility::WrenchEffortRecord::enableResistiveLinearEffortZ

(

void

)

enableResistiveRotationalEffortX()

void openjaus::mobility::WrenchEffortRecord::enableResistiveRotationalEffortX

(

void

)

enableResistiveRotationalEffortY()

void openjaus::mobility::WrenchEffortRecord::enableResistiveRotationalEffortY

(

void

)

enableResistiveRotationalEffortZ()

void openjaus::mobility::WrenchEffortRecord::enableResistiveRotationalEffortZ

(

void

)

from()

int openjaus::mobility::WrenchEffortRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getPresenceVector()

uint16_t openjaus::mobility::WrenchEffortRecord::getPresenceVector

(

void

)

const

getPropulsiveLinearEffortX_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveLinearEffortX_percent

(

void

)

getPropulsiveLinearEffortY_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveLinearEffortY_percent

(

void

)

getPropulsiveLinearEffortZ_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveLinearEffortZ_percent

(

void

)

getPropulsiveRotationalEffortX_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveRotationalEffortX_percent

(

void

)

getPropulsiveRotationalEffortY_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveRotationalEffortY_percent

(

void

)

getPropulsiveRotationalEffortZ_percent()

double openjaus::mobility::WrenchEffortRecord::getPropulsiveRotationalEffortZ_percent

(

void

)

getResistiveLinearEffortX_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveLinearEffortX_percent

(

void

)

getResistiveLinearEffortY_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveLinearEffortY_percent

(

void

)

getResistiveLinearEffortZ_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveLinearEffortZ_percent

(

void

)

getResistiveRotationalEffortX_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveRotationalEffortX_percent

(

void

)

getResistiveRotationalEffortY_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveRotationalEffortY_percent

(

void

)

getResistiveRotationalEffortZ_percent()

double openjaus::mobility::WrenchEffortRecord::getResistiveRotationalEffortZ_percent

(

void

)

isPropulsiveLinearEffortXEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveLinearEffortXEnabled

(

void

)

const

isPropulsiveLinearEffortYEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveLinearEffortYEnabled

(

void

)

const

isPropulsiveLinearEffortZEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveLinearEffortZEnabled

(

void

)

const

isPropulsiveRotationalEffortXEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveRotationalEffortXEnabled

(

void

)

const

isPropulsiveRotationalEffortYEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveRotationalEffortYEnabled

(

void

)

const

isPropulsiveRotationalEffortZEnabled()

bool openjaus::mobility::WrenchEffortRecord::isPropulsiveRotationalEffortZEnabled

(

void

)

const

isResistiveLinearEffortXEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveLinearEffortXEnabled

(

void

)

const

isResistiveLinearEffortYEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveLinearEffortYEnabled

(

void

)

const

isResistiveLinearEffortZEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveLinearEffortZEnabled

(

void

)

const

isResistiveRotationalEffortXEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveRotationalEffortXEnabled

(

void

)

const

isResistiveRotationalEffortYEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveRotationalEffortYEnabled

(

void

)

const

isResistiveRotationalEffortZEnabled()

bool openjaus::mobility::WrenchEffortRecord::isResistiveRotationalEffortZEnabled

(

void

)

const

length()

int openjaus::mobility::WrenchEffortRecord::length ( void  )

virtual

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

setPresenceVector()

void openjaus::mobility::WrenchEffortRecord::setPresenceVector

(

uint16_t

value

)

setPropulsiveLinearEffortX_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveLinearEffortX_percent

(

double

value

)

setPropulsiveLinearEffortY_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveLinearEffortY_percent

(

double

value

)

setPropulsiveLinearEffortZ_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveLinearEffortZ_percent

(

double

value

)

setPropulsiveRotationalEffortX_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveRotationalEffortX_percent

(

double

value

)

setPropulsiveRotationalEffortY_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveRotationalEffortY_percent

(

double

value

)

setPropulsiveRotationalEffortZ_percent()

bool openjaus::mobility::WrenchEffortRecord::setPropulsiveRotationalEffortZ_percent

(

double

value

)

setResistiveLinearEffortX_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveLinearEffortX_percent

(

double

value

)

setResistiveLinearEffortY_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveLinearEffortY_percent

(

double

value

)

setResistiveLinearEffortZ_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveLinearEffortZ_percent

(

double

value

)

setResistiveRotationalEffortX_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveRotationalEffortX_percent

(

double

value

)

setResistiveRotationalEffortY_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveRotationalEffortY_percent

(

double

value

)

setResistiveRotationalEffortZ_percent()

bool openjaus::mobility::WrenchEffortRecord::setResistiveRotationalEffortZ_percent

(

double

value

)

to()

int openjaus::mobility::WrenchEffortRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::mobility::WrenchEffortRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

presenceVector

uint16_t openjaus::mobility::WrenchEffortRecord::presenceVector

protected

propulsiveLinearEffortX_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveLinearEffortX_percent

protected

propulsiveLinearEffortY_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveLinearEffortY_percent

protected

propulsiveLinearEffortZ_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveLinearEffortZ_percent

protected

propulsiveRotationalEffortX_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveRotationalEffortX_percent

protected

propulsiveRotationalEffortY_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveRotationalEffortY_percent

protected

propulsiveRotationalEffortZ_percent

PropulsiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::propulsiveRotationalEffortZ_percent

protected

PV_ALL_FIELDS

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_ALL_FIELDS = 0xFFFF

static

PV_NO_FIELDS

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_NO_FIELDS = 0x0

static

PV_PROPULSIVELINEAREFFORTX

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVELINEAREFFORTX = 0x1

static

PV_PROPULSIVELINEAREFFORTY

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVELINEAREFFORTY = 0x2

static

PV_PROPULSIVELINEAREFFORTZ

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVELINEAREFFORTZ = 0x4

static

PV_PROPULSIVEROTATIONALEFFORTX

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVEROTATIONALEFFORTX = 0x8

static

PV_PROPULSIVEROTATIONALEFFORTY

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVEROTATIONALEFFORTY = 0x10

static

PV_PROPULSIVEROTATIONALEFFORTZ

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_PROPULSIVEROTATIONALEFFORTZ = 0x20

static

PV_RESISTIVELINEAREFFORTX

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVELINEAREFFORTX = 0x40

static

PV_RESISTIVELINEAREFFORTY

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVELINEAREFFORTY = 0x80

static

PV_RESISTIVELINEAREFFORTZ

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVELINEAREFFORTZ = 0x100

static

PV_RESISTIVEROTATIONALEFFORTX

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVEROTATIONALEFFORTX = 0x200

static

PV_RESISTIVEROTATIONALEFFORTY

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVEROTATIONALEFFORTY = 0x400

static

PV_RESISTIVEROTATIONALEFFORTZ

const uint16_t openjaus::mobility::WrenchEffortRecord::PV_RESISTIVEROTATIONALEFFORTZ = 0x800

static

resistiveLinearEffortX_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveLinearEffortX_percent

protected

resistiveLinearEffortY_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveLinearEffortY_percent

protected

resistiveLinearEffortZ_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveLinearEffortZ_percent

protected

resistiveRotationalEffortX_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveRotationalEffortX_percent

protected

resistiveRotationalEffortY_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveRotationalEffortY_percent

protected

resistiveRotationalEffortZ_percent

ResistiveEffortScaledInteger openjaus::mobility::WrenchEffortRecord::resistiveRotationalEffortZ_percent

protected

---

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

• include/openjaus/mobility/Triggers/Fields/WrenchEffortRecord.h
• src/openjaus/mobility/Triggers/Fields/WrenchEffortRecord.cpp