openjaus::model::fields::Short Class Reference

This is a brief description. More...

#include <Short.h>

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

Public Member Functions
	Short ()
virtual	~Short ()
int16_t	getValue () const
	Accessor to get the value of value. More...
bool	setValue (int16_t value)
	Accessor to set value of value. 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::Signed
	Signed ()
virtual	~Signed ()
Public Member Functions inherited from openjaus::model::fields::FixedPoint
virtual	~FixedPoint ()
Public Member Functions inherited from openjaus::model::fields::Unitized
virtual	~Unitized ()
Units	getUnits () const
	Accessor to get the value of units. More...
bool	setUnits (Units units)
	Accessor to set value of units. More...
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
int16_t	value
Protected Attributes inherited from openjaus::model::fields::Unitized
Units	units
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

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

Detailed Description

Detailed description.

Author

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

Constructor & Destructor Documentation

Short()

openjaus::model::fields::Short::Short

(

)

~Short()

openjaus::model::fields::Short::~Short ( )

virtual

Member Function Documentation

from()

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

getValue()

int16_t openjaus::model::fields::Short::getValue

(

)

const

length()

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

virtual

Implements openjaus::system::Transportable.

setValue()

bool openjaus::model::fields::Short::setValue

(

int16_t

value

)

Parameters

value

The value of the new value.

to()

uint64 openjaus::model::fields::Short::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::Short::toString ( ) const

virtual

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

toXml()

std::string openjaus::model::fields::Short::toXml

(

unsigned char

level = 0

)

const

Friends And Related Function Documentation

operator<< [1/2]

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

friend

operator<< [2/2]

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

friend

Member Data Documentation

value

int16_t openjaus::model::fields::Short::value

protected

---

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

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