openjaus::model::fields::VariableLengthString Class Reference

This is a brief description. More...

#include <VariableLengthString.h>

Inherits openjaus::model::fields::Field, and openjaus::system::Transportable.

Public Member Functions
	VariableLengthString ()
virtual	~VariableLengthString ()
std::string	getValue () const
	Accessor to get the value of value. More...
bool	setValue (std::string value)
	Accessor to set value of value. More...
std::string	getDefaultValue () const
	Accessor to get the value of defaultValue. More...
bool	setDefaultValue (std::string defaultValue)
	Accessor to set value of defaultValue. More...
TypesUnsigned	getSizeType () const
	Accessor to get the value of sizeType. More...
bool	setSizeType (TypesUnsigned sizeType)
	Accessor to set value of sizeType. More...
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 () const
	Gets the serialized length of this object. More...
virtual std::string	toString () const
std::string	toXml (unsigned char level=0) const
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
std::string	value
std::string	defaultValue
TypesUnsigned	sizeType
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Private Member Functions
uint64	packLength (system::BufferWriter &dst) const
uint64	unpackLength (system::BufferReader &src, uint64 &length)

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const VariableLengthString &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const VariableLengthString *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

VariableLengthString()

openjaus::model::fields::VariableLengthString::VariableLengthString

(

)

~VariableLengthString()

openjaus::model::fields::VariableLengthString::~VariableLengthString ( )

virtual

Member Function Documentation

from()

uint64 openjaus::model::fields::VariableLengthString::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

Implements openjaus::system::Transportable.

getDefaultValue()

std::string openjaus::model::fields::VariableLengthString::getDefaultValue

(

)

const

getSizeType()

TypesUnsigned openjaus::model::fields::VariableLengthString::getSizeType

(

)

const

getValue()

std::string openjaus::model::fields::VariableLengthString::getValue

(

)

const

length()

uint64 openjaus::model::fields::VariableLengthString::length ( ) const

virtual

Implements openjaus::system::Transportable.

packLength()

uint64 openjaus::model::fields::VariableLengthString::packLength ( system::BufferWriter &  dst ) const

private

setDefaultValue()

bool openjaus::model::fields::VariableLengthString::setDefaultValue

(

std::string

defaultValue

)

Parameters

defaultValue

The value of the new defaultValue.

setSizeType()

bool openjaus::model::fields::VariableLengthString::setSizeType

(

TypesUnsigned

sizeType

)

Parameters

sizeType

The value of the new sizeType.

setValue()

bool openjaus::model::fields::VariableLengthString::setValue

(

std::string

value

)

Parameters

value

The value of the new value.

to()

uint64 openjaus::model::fields::VariableLengthString::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

Implements openjaus::system::Transportable.

toString()

std::string openjaus::model::fields::VariableLengthString::toString ( ) const

virtual

Reimplemented from openjaus::model::fields::Field.

toXml()

std::string openjaus::model::fields::VariableLengthString::toXml

(

unsigned char

level = 0

)

const

unpackLength()

uint64 openjaus::model::fields::VariableLengthString::unpackLength ( system::BufferReader &  src, uint64 &  length  )

private

Friends And Related Function Documentation

operator<< [1/2]

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

friend

operator<< [2/2]

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

friend

Member Data Documentation

defaultValue

std::string openjaus::model::fields::VariableLengthString::defaultValue

protected

sizeType

TypesUnsigned openjaus::model::fields::VariableLengthString::sizeType

protected

value

std::string openjaus::model::fields::VariableLengthString::value

protected

---

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

• include/openjaus/model/fields/VariableLengthString.h
• src/openjaus/model/fields/VariableLengthString.cpp