OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
openjaus::manipulator::ReportEndEffectorVelocityState Class Reference

ReportEndEffectorVelocityState Message Implementation. More...

#include <ReportEndEffectorVelocityState.h>

Inherits openjaus::model::Message.

Public Member Functions

 ReportEndEffectorVelocityState ()
 
 ReportEndEffectorVelocityState (model::Message *message)
 
 ~ReportEndEffectorVelocityState ()
 
virtual int to (system::Buffer *dst)
 Pack this message to the given openjaus::system::Buffer. More...
 
virtual int from (system::Buffer *src)
 Unpack this message from the given openjaus::system::Buffer. More...
 
virtual int length ()
 Get the number of bytes this message would occupy in a serialized buffer. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 Used to serialize the runtime state of the message to an XML format. More...
 
std::string toString () const
 Returns a string populated with the Message name and ID More...
 
double getAngularVelocityComponentX_rps (void)
 
bool setAngularVelocityComponentX_rps (double value)
 
double getAngularVelocityComponentY_rps (void)
 
bool setAngularVelocityComponentY_rps (double value)
 
double getAngularVelocityComponentZ_rps (void)
 
bool setAngularVelocityComponentZ_rps (double value)
 
double getLinearVelocityComponentX_mps (void)
 
bool setLinearVelocityComponentX_mps (double value)
 
double getLinearVelocityComponentY_mps (void)
 
bool setLinearVelocityComponentY_mps (double value)
 
double getLinearVelocityComponentZ_mps (void)
 
bool setLinearVelocityComponentZ_mps (double value)
 
- Public Member Functions inherited from openjaus::model::Message
 Message ()
 
virtual ~Message ()
 
 Message (Message *message)
 
int to (system::Buffer *dst)
 Operation to. More...
 
int from (system::Buffer *src)
 Operation from. More...
 
- Public Member Functions inherited from openjaus::transport::Wrapper
 Wrapper ()
 
virtual ~Wrapper ()
 
AckNakType getAckNak () const
 Accessor to get the value of ackNak. More...
 
bool setAckNak (AckNakType ackNak)
 Accessor to set value of ackNak. More...
 
bool isCompressible () const
 Accessor to get the value of compressible. More...
 
bool setCompressible (bool compressible)
 Accessor to set value of compressible. More...
 
bool isMustArrive () const
 Accessor to get the value of mustArrive. More...
 
bool setMustArrive (bool mustArrive)
 Accessor to set value of mustArrive. More...
 
uint16_t getSequenceNumber () const
 Accessor to get the value of sequenceNumber. More...
 
bool setSequenceNumber (uint16_t sequenceNumber)
 Accessor to set value of sequenceNumber. More...
 
WrapperType getType () const
 Accessor to get the value of type. More...
 
bool setType (WrapperType type)
 Accessor to set value of type. More...
 
Priority getPriority () const
 Accessor to get the value of priority. More...
 
bool setPriority (Priority priority)
 Accessor to set value of priority. More...
 
BroadcastType getBroadcastFlag () const
 Accessor to get the value of broadcastFlag. More...
 
bool setBroadcastFlag (BroadcastType broadcastFlag)
 Accessor to set value of broadcastFlag. More...
 
LargeMessageType getLargeMessageFlag () const
 Accessor to get the value of largeMessageFlag. More...
 
bool setLargeMessageFlag (LargeMessageType largeMessageFlag)
 Accessor to set value of largeMessageFlag. More...
 
const AddressgetDestination () const
 Accessor to get the value of destination. More...
 
bool setDestination (const Address &destination)
 Accessor to set value of destination. More...
 
system::TransportablegetPayload () const
 Accessor to get the value of payload. More...
 
bool setPayload (system::Transportable *payload)
 Accessor to set value of payload. More...
 
const AddressgetSource () const
 Accessor to get the value of source. More...
 
bool setSource (const Address &source)
 Accessor to set value of source. More...
 
TransportDatagetTransportData () const
 Accessor to get the value of transportData. More...
 
bool setTransportData (TransportData *transportData)
 Accessor to set value of transportData. More...
 
virtual int prioritizedValue ()
 Operation prioritizedValue. More...
 
virtual Wrapperclone ()
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 
- Public Member Functions inherited from openjaus::system::Prioritized
virtual ~Prioritized ()
 
- Public Member Functions inherited from openjaus::model::Trigger
 Trigger ()
 
virtual ~Trigger ()
 
double getTriggerTimestamp_sec () const
 Accessor to get the value of triggerTimestamp_sec. More...
 
bool setTriggerTimestamp_sec (double triggerTimestamp_sec)
 Accessor to set value of triggerTimestamp_sec. More...
 
uint32_t getId () const
 Accessor to get the value of id. More...
 
bool setId (uint32_t id)
 Accessor to set value of id. More...
 
std::string idString ()
 Operation idString. More...
 

Static Public Attributes

static const uint16_t ID = 0x4616
 
static const double ANGULARVELOCITYCOMPONENTX_MIN_VALUE = -62.83185307179586
 
static const double ANGULARVELOCITYCOMPONENTX_MAX_VALUE = 62.83185307179586
 
static const double ANGULARVELOCITYCOMPONENTY_MIN_VALUE = -62.83185307179586
 
static const double ANGULARVELOCITYCOMPONENTY_MAX_VALUE = 62.83185307179586
 
static const double ANGULARVELOCITYCOMPONENTZ_MIN_VALUE = -62.83185307179586
 
static const double ANGULARVELOCITYCOMPONENTZ_MAX_VALUE = 62.83185307179586
 
static const double LINEARVELOCITYCOMPONENTX_MIN_VALUE = -10.0
 
static const double LINEARVELOCITYCOMPONENTX_MAX_VALUE = 10.0
 
static const double LINEARVELOCITYCOMPONENTY_MIN_VALUE = -10.0
 
static const double LINEARVELOCITYCOMPONENTY_MAX_VALUE = 10.0
 
static const double LINEARVELOCITYCOMPONENTZ_MIN_VALUE = -10.0
 
static const double LINEARVELOCITYCOMPONENTZ_MAX_VALUE = 10.0
 

Private Attributes

AngularVelocityComponentXScaledInteger angularVelocityComponentX_rps
 
AngularVelocityComponentYScaledInteger angularVelocityComponentY_rps
 
AngularVelocityComponentZScaledInteger angularVelocityComponentZ_rps
 
LinearVelocityComponentXScaledInteger linearVelocityComponentX_mps
 
LinearVelocityComponentYScaledInteger linearVelocityComponentY_mps
 
LinearVelocityComponentZScaledInteger linearVelocityComponentZ_mps
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportEndEffectorVelocityState &object)
 OStream operator for Message object More...
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportEndEffectorVelocityState *object)
 OStream operator for Message pointer More...
 

Additional Inherited Members

- Protected Member Functions inherited from openjaus::transport::Wrapper
 Wrapper (const Wrapper &wrapper)
 
- Protected Attributes inherited from openjaus::transport::Wrapper
AckNakType ackNak
 
bool compressible
 
bool mustArrive
 
uint16_t sequenceNumber
 
WrapperType type
 
Priority priority
 
BroadcastType broadcastFlag
 
LargeMessageType largeMessageFlag
 
Address destination
 
system::Transportablepayload
 
Address source
 
TransportDatatransportData
 
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
 
uint32_t id
 

Detailed Description

This message provides the receiver with the current end effector velocity state for the manipulator.

Constructor & Destructor Documentation

§ ReportEndEffectorVelocityState() [1/2]

openjaus::manipulator::ReportEndEffectorVelocityState::ReportEndEffectorVelocityState ( )

§ ReportEndEffectorVelocityState() [2/2]

openjaus::manipulator::ReportEndEffectorVelocityState::ReportEndEffectorVelocityState ( model::Message message)

§ ~ReportEndEffectorVelocityState()

openjaus::manipulator::ReportEndEffectorVelocityState::~ReportEndEffectorVelocityState ( )

Member Function Documentation

§ from()

int openjaus::manipulator::ReportEndEffectorVelocityState::from ( system::Buffer src)
virtual
Parameters
[in]src- The source openjaus::system::Buffer from which this message will be unpacked.
Returns
The number of bytes unpacked from the source buffer

Reimplemented from openjaus::transport::Wrapper.

§ getAngularVelocityComponentX_rps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getAngularVelocityComponentX_rps ( void  )

§ getAngularVelocityComponentY_rps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getAngularVelocityComponentY_rps ( void  )

§ getAngularVelocityComponentZ_rps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getAngularVelocityComponentZ_rps ( void  )

§ getLinearVelocityComponentX_mps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getLinearVelocityComponentX_mps ( void  )

§ getLinearVelocityComponentY_mps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getLinearVelocityComponentY_mps ( void  )

§ getLinearVelocityComponentZ_mps()

double openjaus::manipulator::ReportEndEffectorVelocityState::getLinearVelocityComponentZ_mps ( void  )

§ length()

int openjaus::manipulator::ReportEndEffectorVelocityState::length ( void  )
virtual
Returns
The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

§ setAngularVelocityComponentX_rps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setAngularVelocityComponentX_rps ( double  value)

§ setAngularVelocityComponentY_rps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setAngularVelocityComponentY_rps ( double  value)

§ setAngularVelocityComponentZ_rps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setAngularVelocityComponentZ_rps ( double  value)

§ setLinearVelocityComponentX_mps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setLinearVelocityComponentX_mps ( double  value)

§ setLinearVelocityComponentY_mps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setLinearVelocityComponentY_mps ( double  value)

§ setLinearVelocityComponentZ_mps()

bool openjaus::manipulator::ReportEndEffectorVelocityState::setLinearVelocityComponentZ_mps ( double  value)

§ to()

int openjaus::manipulator::ReportEndEffectorVelocityState::to ( system::Buffer dst)
virtual
Parameters
[out]dst- The destination openjaus::system::Buffer to which this message will be packed.
Returns
The number of bytes packed into the destination buffer

Reimplemented from openjaus::transport::Wrapper.

§ toString()

std::string openjaus::manipulator::ReportEndEffectorVelocityState::toString ( ) const
virtual
Returns
The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::manipulator::ReportEndEffectorVelocityState::toXml ( unsigned char  ojIndentLevel = 0) const
Parameters
[in]ojIndentLevel- Used to determine how many tabs are inserted per line for pretty formating.
Returns
The serialized XML string

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ReportEndEffectorVelocityState object 
)
friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ReportEndEffectorVelocityState object 
)
friend

Member Data Documentation

§ ANGULARVELOCITYCOMPONENTX_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTX_MAX_VALUE = 62.83185307179586
static

§ ANGULARVELOCITYCOMPONENTX_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTX_MIN_VALUE = -62.83185307179586
static

§ angularVelocityComponentX_rps

AngularVelocityComponentXScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::angularVelocityComponentX_rps
private

§ ANGULARVELOCITYCOMPONENTY_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTY_MAX_VALUE = 62.83185307179586
static

§ ANGULARVELOCITYCOMPONENTY_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTY_MIN_VALUE = -62.83185307179586
static

§ angularVelocityComponentY_rps

AngularVelocityComponentYScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::angularVelocityComponentY_rps
private

§ ANGULARVELOCITYCOMPONENTZ_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTZ_MAX_VALUE = 62.83185307179586
static

§ ANGULARVELOCITYCOMPONENTZ_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::ANGULARVELOCITYCOMPONENTZ_MIN_VALUE = -62.83185307179586
static

§ angularVelocityComponentZ_rps

AngularVelocityComponentZScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::angularVelocityComponentZ_rps
private

§ ID

const uint16_t openjaus::manipulator::ReportEndEffectorVelocityState::ID = 0x4616
static

§ LINEARVELOCITYCOMPONENTX_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTX_MAX_VALUE = 10.0
static

§ LINEARVELOCITYCOMPONENTX_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTX_MIN_VALUE = -10.0
static

§ linearVelocityComponentX_mps

LinearVelocityComponentXScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::linearVelocityComponentX_mps
private

§ LINEARVELOCITYCOMPONENTY_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTY_MAX_VALUE = 10.0
static

§ LINEARVELOCITYCOMPONENTY_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTY_MIN_VALUE = -10.0
static

§ linearVelocityComponentY_mps

LinearVelocityComponentYScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::linearVelocityComponentY_mps
private

§ LINEARVELOCITYCOMPONENTZ_MAX_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTZ_MAX_VALUE = 10.0
static

§ LINEARVELOCITYCOMPONENTZ_MIN_VALUE

const double openjaus::manipulator::ReportEndEffectorVelocityState::LINEARVELOCITYCOMPONENTZ_MIN_VALUE = -10.0
static

§ linearVelocityComponentZ_mps

LinearVelocityComponentZScaledInteger openjaus::manipulator::ReportEndEffectorVelocityState::linearVelocityComponentZ_mps
private

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