openjaus::mobility::QueryWrenchEffort Class Reference

QueryWrenchEffort Message Implementation. More...

#include <QueryWrenchEffort.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	QueryWrenchEffort ()
	QueryWrenchEffort (model::Message *message)
	~QueryWrenchEffort ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer.
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer.
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer.
std::string	toXml (unsigned char level=0) const
	Used to serialize the runtime state of the message to an XML format.
uint16_t	getQueryPresenceVector (void)
void	setQueryPresenceVector (uint16_t value)
Static Public Attributes
static const uint16_t	ID = 0x2405
Private Attributes
model::fields::UnsignedShort	queryPresenceVector

---

Detailed Description

This message shall cause the receiving component to reply to the requestor with a ID 4405h: ReportWrenchEffort message. A logical AND shall be performed on the requested presence vector and that representing the available fields from the responder. The resulting message shall contain the fields indicated by the result of this logical AND operation.

---

Constructor & Destructor Documentation

openjaus::mobility::QueryWrenchEffort::QueryWrenchEffort

(

)

openjaus::mobility::QueryWrenchEffort::QueryWrenchEffort

(

model::Message *

message

)

openjaus::mobility::QueryWrenchEffort::~QueryWrenchEffort

(

)

---

Member Function Documentation

int openjaus::mobility::QueryWrenchEffort::from

(

system::Buffer *

src

)

[virtual]

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::model::Message.

uint16_t openjaus::mobility::QueryWrenchEffort::getQueryPresenceVector

(

void

)

int openjaus::mobility::QueryWrenchEffort::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::QueryWrenchEffort::setQueryPresenceVector

(

uint16_t

value

)

int openjaus::mobility::QueryWrenchEffort::to

(

system::Buffer *

dst

)

[virtual]

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::model::Message.

std::string openjaus::mobility::QueryWrenchEffort::toXml

(

unsigned char

level = 0

)

const

level - Used to determine how many tabs are inserted per line for pretty formating.

Returns:

The serialized XML string

---

Member Data Documentation

const uint16_t openjaus::mobility::QueryWrenchEffort::ID = 0x2405 [static]

model::fields::UnsignedShort openjaus::mobility::QueryWrenchEffort::queryPresenceVector [private]

---

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

• include/openjaus/mobility/Triggers/QueryWrenchEffort.h
• src/openjaus/mobility/Triggers/QueryWrenchEffort.cpp