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

UpdateEvent Message Implementation. More...

#include <UpdateEvent.h>

Inherits openjaus::model::Message.

Public Member Functions

 UpdateEvent ()
 UpdateEvent (model::Message *message)
 ~UpdateEvent ()
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 getRequestID (void)
bool setRequestID (uint8_t value)
EventTypeEnumeration::EventTypeEnum getEventType (void)
bool setEventType (EventTypeEnumeration::EventTypeEnum value)
std::string getEventTypeToString (void)
double getRequestedPeriodicRate_Hz (void)
bool setRequestedPeriodicRate_Hz (double value)
uint8_t getEventID (void)
bool setEventID (uint8_t value)
model::MessagegetQueryMessage (void)
bool setQueryMessage (model::Message *message)
- 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 = 0x01F1
static const double REQUESTEDPERIODICRATE_MAX_VALUE = 1092.0

Private Attributes

model::fields::UnsignedByte requestID
EventTypeEnumeration eventType
PeriodicRateScaledInteger requestedPeriodicRate_Hz
model::fields::UnsignedByte eventID
model::fields::MessageField queryMessage


OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const UpdateEvent &object)
 OStream operator for Message object More...
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const UpdateEvent *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
Address source
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
uint32_t id

Detailed Description

Constructor & Destructor Documentation

§ UpdateEvent() [1/2]

openjaus::core::UpdateEvent::UpdateEvent ( )

§ UpdateEvent() [2/2]

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

§ ~UpdateEvent()

openjaus::core::UpdateEvent::~UpdateEvent ( )

Member Function Documentation

§ from()

int openjaus::core::UpdateEvent::from ( system::Buffer src)
[in]src- The source openjaus::system::Buffer from which this message will be unpacked.
The number of bytes unpacked from the source buffer

Reimplemented from openjaus::transport::Wrapper.

§ getEventID()

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

§ getEventType()

EventTypeEnumeration::EventTypeEnum openjaus::core::UpdateEvent::getEventType ( void  )

§ getEventTypeToString()

std::string openjaus::core::UpdateEvent::getEventTypeToString ( void  )

§ getQueryMessage()

model::Message * openjaus::core::UpdateEvent::getQueryMessage ( void  )

§ getRequestedPeriodicRate_Hz()

double openjaus::core::UpdateEvent::getRequestedPeriodicRate_Hz ( void  )

§ getRequestID()

uint8_t openjaus::core::UpdateEvent::getRequestID ( void  )

§ length()

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

Reimplemented from openjaus::model::Message.

§ setEventID()

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

§ setEventType()

bool openjaus::core::UpdateEvent::setEventType ( EventTypeEnumeration::EventTypeEnum  value)

§ setQueryMessage()

bool openjaus::core::UpdateEvent::setQueryMessage ( model::Message message)

§ setRequestedPeriodicRate_Hz()

bool openjaus::core::UpdateEvent::setRequestedPeriodicRate_Hz ( double  value)

§ setRequestID()

bool openjaus::core::UpdateEvent::setRequestID ( uint8_t  value)

§ to()

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

Reimplemented from openjaus::transport::Wrapper.

§ toString()

std::string openjaus::core::UpdateEvent::toString ( ) const
The string

Reimplemented from openjaus::model::Message.

§ toXml()

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

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ eventID

model::fields::UnsignedByte openjaus::core::UpdateEvent::eventID

§ eventType

EventTypeEnumeration openjaus::core::UpdateEvent::eventType

§ ID

const uint16_t openjaus::core::UpdateEvent::ID = 0x01F1

§ queryMessage

model::fields::MessageField openjaus::core::UpdateEvent::queryMessage

§ requestedPeriodicRate_Hz

PeriodicRateScaledInteger openjaus::core::UpdateEvent::requestedPeriodicRate_Hz


const double openjaus::core::UpdateEvent::REQUESTEDPERIODICRATE_MAX_VALUE = 1092.0


const double openjaus::core::UpdateEvent::REQUESTEDPERIODICRATE_MIN_VALUE = 0.0

§ requestID

model::fields::UnsignedByte openjaus::core::UpdateEvent::requestID

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