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

ConfirmEventRequest Message Implementation. More...

#include <ConfirmEventRequest.h>

Inherits openjaus::model::Message.

Public Member Functions

 ConfirmEventRequest ()
 
 ConfirmEventRequest (model::Message *message)
 
 ~ConfirmEventRequest ()
 
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...
 
int8_t getRequestID (void)
 
bool setRequestID (int8_t value)
 
int8_t getEventID (void)
 
bool setEventID (int8_t value)
 
double getConfirmedPeriodicRate_Hz (void)
 
bool setConfirmedPeriodicRate_Hz (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 = 0x01F3
 
static const double CONFIRMEDPERIODICRATE_MIN_VALUE = 0.0
 
static const double CONFIRMEDPERIODICRATE_MAX_VALUE = 1092.0
 

Private Attributes

model::fields::Byte requestID
 
model::fields::Byte eventID
 
PeriodicRateScaledInteger confirmedPeriodicRate_Hz
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ConfirmEventRequest &object)
 OStream operator for Message object More...
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ConfirmEventRequest *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

The Confirm Event message is used to confirm an Event has been created/updated/or cancelled. Field 1 represents the Request ID from the Create, Update, or Cancel message that initiated this message. The Request IDís scope is local to the requesting client only. Field 2, Event ID, is a globally unique ID that is established by the service when the event is created. Field 3 is used to specify the closest rate that the service can provide if it cannot match the requested rate.

Constructor & Destructor Documentation

§ ConfirmEventRequest() [1/2]

openjaus::core::ConfirmEventRequest::ConfirmEventRequest ( )

§ ConfirmEventRequest() [2/2]

openjaus::core::ConfirmEventRequest::ConfirmEventRequest ( model::Message message)

§ ~ConfirmEventRequest()

openjaus::core::ConfirmEventRequest::~ConfirmEventRequest ( )

Member Function Documentation

§ from()

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

§ getConfirmedPeriodicRate_Hz()

double openjaus::core::ConfirmEventRequest::getConfirmedPeriodicRate_Hz ( void  )

§ getEventID()

int8_t openjaus::core::ConfirmEventRequest::getEventID ( void  )

§ getRequestID()

int8_t openjaus::core::ConfirmEventRequest::getRequestID ( void  )

§ length()

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

Reimplemented from openjaus::model::Message.

§ setConfirmedPeriodicRate_Hz()

bool openjaus::core::ConfirmEventRequest::setConfirmedPeriodicRate_Hz ( double  value)

§ setEventID()

bool openjaus::core::ConfirmEventRequest::setEventID ( int8_t  value)

§ setRequestID()

bool openjaus::core::ConfirmEventRequest::setRequestID ( int8_t  value)

§ to()

int openjaus::core::ConfirmEventRequest::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::ConfirmEventRequest::toString ( ) const
virtual
Returns
The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::core::ConfirmEventRequest::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 ConfirmEventRequest object 
)
friend

§ operator<< [2/2]

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

Member Data Documentation

§ confirmedPeriodicRate_Hz

PeriodicRateScaledInteger openjaus::core::ConfirmEventRequest::confirmedPeriodicRate_Hz
private

§ CONFIRMEDPERIODICRATE_MAX_VALUE

const double openjaus::core::ConfirmEventRequest::CONFIRMEDPERIODICRATE_MAX_VALUE = 1092.0
static

§ CONFIRMEDPERIODICRATE_MIN_VALUE

const double openjaus::core::ConfirmEventRequest::CONFIRMEDPERIODICRATE_MIN_VALUE = 0.0
static

§ eventID

model::fields::Byte openjaus::core::ConfirmEventRequest::eventID
private

§ ID

const uint16_t openjaus::core::ConfirmEventRequest::ID = 0x01F3
static

§ requestID

model::fields::Byte openjaus::core::ConfirmEventRequest::requestID
private

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