openjaus::ugv_v1_0::PowerPlantDescRecord Class Reference

#include <PowerPlantDescRecord.h>

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

Public Member Functions
	PowerPlantDescRecord ()
	PowerPlantDescRecord (const PowerPlantDescRecord &source)
	~PowerPlantDescRecord ()
void	copy (PowerPlantDescRecord &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
uint8_t	getPowerPlantID (void)
bool	setPowerPlantID (uint8_t value)
std::string	getDescription (void)
bool	setDescription (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 ()

Protected Attributes
model::fields::UnsignedByte	powerPlantID
model::fields::VariableLengthString	description
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

PowerPlantDescRecord() [1/2]

openjaus::ugv_v1_0::PowerPlantDescRecord::PowerPlantDescRecord

(

)

PowerPlantDescRecord() [2/2]

openjaus::ugv_v1_0::PowerPlantDescRecord::PowerPlantDescRecord

(

const PowerPlantDescRecord &

source

)

~PowerPlantDescRecord()

openjaus::ugv_v1_0::PowerPlantDescRecord::~PowerPlantDescRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv_v1_0::PowerPlantDescRecord::copy

(

PowerPlantDescRecord &

source

)

from()

uint64 openjaus::ugv_v1_0::PowerPlantDescRecord::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.

getDescription()

std::string openjaus::ugv_v1_0::PowerPlantDescRecord::getDescription

(

void

)

getPowerPlantID()

uint8_t openjaus::ugv_v1_0::PowerPlantDescRecord::getPowerPlantID

(

void

)

length()

uint64 openjaus::ugv_v1_0::PowerPlantDescRecord::length ( void  ) const

virtual

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

setDescription()

bool openjaus::ugv_v1_0::PowerPlantDescRecord::setDescription

(

std::string

value

)

setPowerPlantID()

bool openjaus::ugv_v1_0::PowerPlantDescRecord::setPowerPlantID

(

uint8_t

value

)

to()

uint64 openjaus::ugv_v1_0::PowerPlantDescRecord::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::ugv_v1_0::PowerPlantDescRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

description

model::fields::VariableLengthString openjaus::ugv_v1_0::PowerPlantDescRecord::description

protected

powerPlantID

model::fields::UnsignedByte openjaus::ugv_v1_0::PowerPlantDescRecord::powerPlantID

protected

---

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

• include/openjaus/ugv_v1_0/Triggers/Fields/PowerPlantDescRecord.h
• src/openjaus/ugv_v1_0/Triggers/Fields/PowerPlantDescRecord.cpp