openjaus::core_v1_1::QueryEventsVariant Class Reference

#include <QueryEventsVariant.h>

Inherits openjaus::model::fields::Variant.

Public Types
enum	TypeEnum { MESSAGEID = 0, EVENTTYPE = 1, EVENTID = 2, ALLEVENTS = 3 }

Public Member Functions
	QueryEventsVariant ()
	~QueryEventsVariant ()
QueryEventsVariant::TypeEnum	getType (void)
void	setType (QueryEventsVariant::TypeEnum type)
void	copy (QueryEventsVariant &source)
virtual uint64	to (system::BufferWriter &dst) const
	Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...
virtual uint64	from (system::BufferReader &src)
	Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...
virtual uint64	length (void) const
	Gets the serialized length of this object. More...
std::string	toXml (unsigned char ojIndentLevel=0) const
uint16_t	getMessageID (void)
bool	setMessageID (uint16_t value)
EventTypeEnumeration::EventTypeEnum	getEventType (void)
bool	setEventType (EventTypeEnumeration::EventTypeEnum value)
std::string	getEventTypeToString (void)
uint8_t	getEventID (void)
bool	setEventID (uint8_t value)
uint8_t	getAllEvents (void)
bool	setAllEvents (uint8_t value)
std::string	typeToString (void)
Public Member Functions inherited from openjaus::model::fields::Variant
	Variant ()
virtual	~Variant ()
virtual std::string	toString () const
Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual	~ComplexField ()
Public Member Functions inherited from openjaus::model::fields::Field
	Field ()
virtual	~Field ()
std::string	getName () const
	Accessor to get the value of name. More...
bool	setName (std::string name)
	Accessor to set value of name. More...
Public Member Functions inherited from openjaus::system::Transportable
	Transportable ()
virtual	~Transportable ()

Private Attributes
TypeEnum	type
model::fields::UnsignedShort	messageID
EventTypeEnumeration	eventType
model::fields::UnsignedByte	eventID
model::fields::UnsignedByte	allEvents

Additional Inherited Members
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Member Enumeration Documentation

TypeEnum

enum openjaus::core_v1_1::QueryEventsVariant::TypeEnum

Enumerator
MESSAGEID
EVENTTYPE
EVENTID
ALLEVENTS

Constructor & Destructor Documentation

QueryEventsVariant()

openjaus::core_v1_1::QueryEventsVariant::QueryEventsVariant

(

)

~QueryEventsVariant()

openjaus::core_v1_1::QueryEventsVariant::~QueryEventsVariant

(

)

Member Function Documentation

copy()

void openjaus::core_v1_1::QueryEventsVariant::copy

(

QueryEventsVariant &

source

)

from()

uint64 openjaus::core_v1_1::QueryEventsVariant::from ( system::BufferReader &  src )

virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters

src

Reimplemented from openjaus::model::fields::Variant.

getAllEvents()

uint8_t openjaus::core_v1_1::QueryEventsVariant::getAllEvents

(

void

)

getEventID()

uint8_t openjaus::core_v1_1::QueryEventsVariant::getEventID

(

void

)

getEventType()

EventTypeEnumeration::EventTypeEnum openjaus::core_v1_1::QueryEventsVariant::getEventType

(

void

)

getEventTypeToString()

std::string openjaus::core_v1_1::QueryEventsVariant::getEventTypeToString

(

void

)

getMessageID()

uint16_t openjaus::core_v1_1::QueryEventsVariant::getMessageID

(

void

)

getType()

QueryEventsVariant::TypeEnum openjaus::core_v1_1::QueryEventsVariant::getType

(

void

)

length()

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

virtual

Reimplemented from openjaus::model::fields::Variant.

setAllEvents()

bool openjaus::core_v1_1::QueryEventsVariant::setAllEvents

(

uint8_t

value

)

setEventID()

bool openjaus::core_v1_1::QueryEventsVariant::setEventID

(

uint8_t

value

)

setEventType()

bool openjaus::core_v1_1::QueryEventsVariant::setEventType

(

EventTypeEnumeration::EventTypeEnum

value

)

setMessageID()

bool openjaus::core_v1_1::QueryEventsVariant::setMessageID

(

uint16_t

value

)

setType()

void openjaus::core_v1_1::QueryEventsVariant::setType

(

QueryEventsVariant::TypeEnum

type

)

to()

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

virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters

dst

Reimplemented from openjaus::model::fields::Variant.

toXml()

std::string openjaus::core_v1_1::QueryEventsVariant::toXml

(

unsigned char

ojIndentLevel = 0

)

const

typeToString()

std::string openjaus::core_v1_1::QueryEventsVariant::typeToString

(

void

)

Member Data Documentation

allEvents

model::fields::UnsignedByte openjaus::core_v1_1::QueryEventsVariant::allEvents

private

eventID

model::fields::UnsignedByte openjaus::core_v1_1::QueryEventsVariant::eventID

private

eventType

EventTypeEnumeration openjaus::core_v1_1::QueryEventsVariant::eventType

private

messageID

model::fields::UnsignedShort openjaus::core_v1_1::QueryEventsVariant::messageID

private

type

TypeEnum openjaus::core_v1_1::QueryEventsVariant::type

private

---

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

• include/openjaus/core_v1_1/Triggers/Fields/QueryEventsVariant.h
• src/openjaus/core_v1_1/Triggers/Fields/QueryEventsVariant.cpp