OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::model::fields::Byte Class Reference

This is a brief description. More...

#include <Byte.h>

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

Public Member Functions

 Byte ()
 
virtual ~Byte ()
 
int8_t getValue () const
 Accessor to get the value of value. More...
 
bool setValue (int8_t value)
 Accessor to set value of value. More...
 
virtual int to (system::Buffer *dst)
 Operation to. More...
 
virtual int from (system::Buffer *src)
 Operation from. More...
 
virtual int length ()
 Serializes object to internal transport buffer. 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
virtual ~Transportable ()
 
 Transportable ()
 

Protected Attributes

int8_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 Byte &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const Byte *object)
 

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ Byte()

openjaus::model::fields::Byte::Byte ( )

§ ~Byte()

openjaus::model::fields::Byte::~Byte ( )
virtual

Member Function Documentation

§ from()

int openjaus::model::fields::Byte::from ( system::Buffer src)
virtual
Parameters
src

Implements openjaus::system::Transportable.

§ getValue()

int8_t openjaus::model::fields::Byte::getValue ( ) const

§ length()

int openjaus::model::fields::Byte::length ( )
virtual

§ setValue()

bool openjaus::model::fields::Byte::setValue ( int8_t  value)
Parameters
valueThe value of the new value.

§ to()

int openjaus::model::fields::Byte::to ( system::Buffer dst)
virtual
Parameters
dst

Implements openjaus::system::Transportable.

§ toString()

std::string openjaus::model::fields::Byte::toString ( ) const
virtual

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

§ toXml()

std::string openjaus::model::fields::Byte::toXml ( unsigned char  level = 0) const

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ value

int8_t openjaus::model::fields::Byte::value
protected

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