CreateCommandEvent Message Implementation. More...

#include <CreateCommandEvent.h>

Public Member Functions
	CreateCommandEvent ()

	CreateCommandEvent (model::Message *message)

	~CreateCommandEvent ()

virtual uint64	to (system::BufferWriter &dst) const
	Pack this message to the given openjaus::system::Buffer. More...

virtual uint64	from (system::BufferReader &src)
	Unpack this message from the given openjaus::system::Buffer. More...

virtual uint64	length () const
	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	getRequestID (void)

bool	setRequestID (uint8_t value)

uint32_t	getMaximumAllowedDuration_sec (void)

bool	setMaximumAllowedDuration_sec (uint32_t value)

model::Message *	getCommandMessage (void)

bool	setCommandMessage (model::Message *message)

Public Member Functions inherited from openjaus::model::Message
	Message ()

virtual	~Message ()

	Message (Message *message)

Public Member Functions inherited from openjaus::transport::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
	Transportable ()

virtual	~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 = 0x01F6

Private Attributes
model::fields::UnsignedByte	requestID

model::fields::UnsignedInteger	maximumAllowedDuration_sec

model::fields::MessageField	commandMessage

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

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

Additional Inherited Members
Protected Member Functions inherited from openjaus::transport::Wrapper
	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

This message is used to set up a command event. Field 1 is a local request ID that the event provider returns in the Confirm or Reject message. Field 2 is the maximum allowed execution time; any command not completed within its specified duration is considered a failure. Field 3 contains the size of the Command message that is to specify the command to be executed. Field 4 contains the encoded command message (including its two byte header).

Constructor & Destructor Documentation

◆ CreateCommandEvent() [1/2]

openjaus::core_v1_1::CreateCommandEvent::CreateCommandEvent ( )

◆ CreateCommandEvent() [2/2]

openjaus::core_v1_1::CreateCommandEvent::CreateCommandEvent ( model::Message * message )

◆ ~CreateCommandEvent()

openjaus::core_v1_1::CreateCommandEvent::~CreateCommandEvent ( )

Member Function Documentation

◆ from()

uint64 openjaus::core_v1_1::CreateCommandEvent::from ( system::BufferReader & 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::model::Message.

◆ getCommandMessage()

model::Message * openjaus::core_v1_1::CreateCommandEvent::getCommandMessage ( void )

◆ getMaximumAllowedDuration_sec()

uint32_t openjaus::core_v1_1::CreateCommandEvent::getMaximumAllowedDuration_sec ( void )

◆ getRequestID()

uint8_t openjaus::core_v1_1::CreateCommandEvent::getRequestID ( void )

◆ length()

uint64 openjaus::core_v1_1::CreateCommandEvent::length ( void ) const

virtual

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

Reimplemented from openjaus::model::Message.

◆ setCommandMessage()

bool openjaus::core_v1_1::CreateCommandEvent::setCommandMessage ( model::Message * message )

◆ setMaximumAllowedDuration_sec()

bool openjaus::core_v1_1::CreateCommandEvent::setMaximumAllowedDuration_sec ( uint32_t value )

◆ setRequestID()

bool openjaus::core_v1_1::CreateCommandEvent::setRequestID ( uint8_t value )

◆ to()

uint64 openjaus::core_v1_1::CreateCommandEvent::to ( system::BufferWriter & dst ) const

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

◆ toString()

std::string openjaus::core_v1_1::CreateCommandEvent::toString ( ) const

virtual

Returns: The string

Reimplemented from openjaus::model::Message.

◆ toXml()

std::string openjaus::core_v1_1::CreateCommandEvent::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 CreateCommandEvent &	object
	)

friend

◆ operator<< [2/2]

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

friend

Member Data Documentation

◆ commandMessage

model::fields::MessageField openjaus::core_v1_1::CreateCommandEvent::commandMessage

private

◆ ID

const uint16_t openjaus::core_v1_1::CreateCommandEvent::ID = 0x01F6

static

◆ maximumAllowedDuration_sec

model::fields::UnsignedInteger openjaus::core_v1_1::CreateCommandEvent::maximumAllowedDuration_sec

private

◆ requestID

model::fields::UnsignedByte openjaus::core_v1_1::CreateCommandEvent::requestID

private

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

include/openjaus/core_v1_1/Triggers/CreateCommandEvent.h
src/openjaus/core_v1_1/Triggers/CreateCommandEvent.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateCommandEvent() [1/2]

◆ CreateCommandEvent() [2/2]

◆ ~CreateCommandEvent()

Member Function Documentation

◆ from()

◆ getCommandMessage()

◆ getMaximumAllowedDuration_sec()

◆ getRequestID()

◆ length()

◆ setCommandMessage()

◆ setMaximumAllowedDuration_sec()

◆ setRequestID()

◆ to()

◆ toString()

◆ toXml()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ commandMessage

◆ ID

◆ maximumAllowedDuration_sec

◆ requestID