CommandEvent Message Implementation. More...

#include <CommandEvent.h>

Public Member Functions
	CommandEvent ()

	CommandEvent (model::Message *message)

	~CommandEvent ()

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...

uint8_t	getEventID (void)

bool	setEventID (uint8_t value)

CommandResultEnumeration::CommandResultEnum	getCommandResult (void)

bool	setCommandResult (CommandResultEnumeration::CommandResultEnum value)

std::string	getCommandResultToString (void)

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 Address &	getDestination () const
	Accessor to get the value of destination. More...

bool	setDestination (const Address &destination)
	Accessor to set value of destination. More...

system::Transportable *	getPayload () const
	Accessor to get the value of payload. More...

bool	setPayload (system::Transportable *payload)
	Accessor to set value of payload. More...

const Address &	getSource () const
	Accessor to get the value of source. More...

bool	setSource (const Address &source)
	Accessor to set value of source. More...

TransportData *	getTransportData () 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 Wrapper *	clone ()

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 = 0x41F6

Private Attributes
model::fields::UnsignedByte	eventID

CommandResultEnumeration	commandResult

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const CommandEvent &object)
	OStream operator for Message object More...

OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const CommandEvent *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::Transportable *	payload

Address	source

TransportData *	transportData

Protected Attributes inherited from openjaus::model::Trigger
double	triggerTimestamp_sec

uint32_t	id

Detailed Description

The CommandEvent message is sent when a command specified by a previous Create Command Event message has completed or expired. It includes the Event ID and command result.

Constructor & Destructor Documentation

§ CommandEvent() [1/2]

openjaus::core::CommandEvent::CommandEvent ( )

§ CommandEvent() [2/2]

openjaus::core::CommandEvent::CommandEvent ( model::Message * message )

§ ~CommandEvent()

openjaus::core::CommandEvent::~CommandEvent ( )

Member Function Documentation

§ from()

int openjaus::core::CommandEvent::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.

§ getCommandResult()

CommandResultEnumeration::CommandResultEnum openjaus::core::CommandEvent::getCommandResult ( void )

§ getCommandResultToString()

std::string openjaus::core::CommandEvent::getCommandResultToString ( void )

§ getEventID()

uint8_t openjaus::core::CommandEvent::getEventID ( void )

§ length()

int openjaus::core::CommandEvent::length ( void )

virtual

Returns: The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

§ setCommandResult()

bool openjaus::core::CommandEvent::setCommandResult ( CommandResultEnumeration::CommandResultEnum value )

§ setEventID()

bool openjaus::core::CommandEvent::setEventID ( uint8_t value )

§ to()

int openjaus::core::CommandEvent::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::core::CommandEvent::toString ( ) const

virtual

Returns: The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::core::CommandEvent::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 CommandEvent &	object
	)

friend

§ operator<< [2/2]

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

friend

Member Data Documentation

§ commandResult

CommandResultEnumeration openjaus::core::CommandEvent::commandResult

private

§ eventID

model::fields::UnsignedByte openjaus::core::CommandEvent::eventID

private

§ ID

const uint16_t openjaus::core::CommandEvent::ID = 0x41F6

static

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

include/openjaus/core/Triggers/CommandEvent.h
src/openjaus/core/Triggers/CommandEvent.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ CommandEvent() [1/2]

§ CommandEvent() [2/2]

§ ~CommandEvent()

Member Function Documentation

§ from()

§ getCommandResult()

§ getCommandResultToString()

§ getEventID()

§ length()

§ setCommandResult()

§ setEventID()

§ to()

§ toString()

§ toXml()

Friends And Related Function Documentation

§ operator<< [1/2]

§ operator<< [2/2]

Member Data Documentation

§ commandResult

§ eventID

§ ID