openjaus::core_v1_1::QSLComponentRecord Class Reference

#include <QSLComponentRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions
	QSLComponentRecord ()
	QSLComponentRecord (const QSLComponentRecord &source)
	~QSLComponentRecord ()
void	copy (QSLComponentRecord &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
void	setPresenceVector (uint8_t value)
uint8_t	getPresenceVector (void) const
bool	isSearchFilterEnabled (void) const
void	enableSearchFilter (void)
void	disableSearchFilter (void)
uint8_t	getComponentID (void)
bool	setComponentID (uint8_t value)
std::string	getSearchFilter (void)
bool	setSearchFilter (std::string value)
Public Member Functions inherited from openjaus::model::fields::Record
	Record ()
virtual	~Record ()
const std::vector< Field *> &	getFields () const
	Accessor to get the value of fields. More...
bool	setFields (const Field &fields)
	Accessor to set value of fields. More...
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 ()

Static Public Attributes
static const uint8_t	PV_NO_FIELDS = 0x0
static const uint8_t	PV_SEARCHFILTER = 0x1
static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS | PV_SEARCHFILTER

Protected Attributes
model::fields::UnsignedByte	componentID
model::fields::VariableLengthString	searchFilter
uint8_t	presenceVector
Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *>	fields
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Constructor & Destructor Documentation

QSLComponentRecord() [1/2]

openjaus::core_v1_1::QSLComponentRecord::QSLComponentRecord

(

)

QSLComponentRecord() [2/2]

openjaus::core_v1_1::QSLComponentRecord::QSLComponentRecord

(

const QSLComponentRecord &

source

)

~QSLComponentRecord()

openjaus::core_v1_1::QSLComponentRecord::~QSLComponentRecord

(

)

Member Function Documentation

copy()

void openjaus::core_v1_1::QSLComponentRecord::copy

(

QSLComponentRecord &

source

)

disableSearchFilter()

void openjaus::core_v1_1::QSLComponentRecord::disableSearchFilter

(

void

)

enableSearchFilter()

void openjaus::core_v1_1::QSLComponentRecord::enableSearchFilter

(

void

)

from()

uint64 openjaus::core_v1_1::QSLComponentRecord::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::Record.

getComponentID()

uint8_t openjaus::core_v1_1::QSLComponentRecord::getComponentID

(

void

)

getPresenceVector()

uint8_t openjaus::core_v1_1::QSLComponentRecord::getPresenceVector

(

void

)

const

getSearchFilter()

std::string openjaus::core_v1_1::QSLComponentRecord::getSearchFilter

(

void

)

isSearchFilterEnabled()

bool openjaus::core_v1_1::QSLComponentRecord::isSearchFilterEnabled

(

void

)

const

length()

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

virtual

Reimplemented from openjaus::model::fields::Record.

setComponentID()

bool openjaus::core_v1_1::QSLComponentRecord::setComponentID

(

uint8_t

value

)

setPresenceVector()

void openjaus::core_v1_1::QSLComponentRecord::setPresenceVector

(

uint8_t

value

)

setSearchFilter()

bool openjaus::core_v1_1::QSLComponentRecord::setSearchFilter

(

std::string

value

)

to()

uint64 openjaus::core_v1_1::QSLComponentRecord::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::Record.

toXml()

std::string openjaus::core_v1_1::QSLComponentRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

componentID

model::fields::UnsignedByte openjaus::core_v1_1::QSLComponentRecord::componentID

protected

presenceVector

uint8_t openjaus::core_v1_1::QSLComponentRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::core_v1_1::QSLComponentRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_SEARCHFILTER

static

PV_NO_FIELDS

const uint8_t openjaus::core_v1_1::QSLComponentRecord::PV_NO_FIELDS = 0x0

static

PV_SEARCHFILTER

const uint8_t openjaus::core_v1_1::QSLComponentRecord::PV_SEARCHFILTER = 0x1

static

searchFilter

model::fields::VariableLengthString openjaus::core_v1_1::QSLComponentRecord::searchFilter

protected

---

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

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