This is a brief description. More...
#include <UnsignedByte.h>
Inherits openjaus::model::fields::Unsigned, openjaus::model::fields::Field, and openjaus::system::Transportable.
Public Member Functions | |
| UnsignedByte () | |
| virtual | ~UnsignedByte () |
| uint8_t | getValue () const |
| Accessor to get the value of value. More... | |
| bool | setValue (uint8_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::Unsigned | |
| Unsigned () | |
| virtual | ~Unsigned () |
| 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 | |
| uint8_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 UnsignedByte &object) |
| OPENJAUS_EXPORT friend std::ostream & | operator<< (std::ostream &output, const UnsignedByte *object) |
Detailed Description
Detailed description.
Constructor & Destructor Documentation
◆ UnsignedByte()
| openjaus::model::fields::UnsignedByte::UnsignedByte | ( | ) |
◆ ~UnsignedByte()
|
virtual |
Member Function Documentation
◆ from()
|
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()
| uint8_t openjaus::model::fields::UnsignedByte::getValue | ( | ) | const |
◆ length()
|
virtual |
Implements openjaus::system::Transportable.
◆ setValue()
| bool openjaus::model::fields::UnsignedByte::setValue | ( | uint8_t | value | ) |
- Parameters
-
value The value of the new value.
◆ to()
|
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()
|
virtual |
Reimplemented from openjaus::model::fields::Field.
◆ toXml()
| std::string openjaus::model::fields::UnsignedByte::toXml | ( | unsigned char | level = 0 | ) | const |
Friends And Related Function Documentation
◆ operator<< [1/2]
|
friend |
◆ operator<< [2/2]
|
friend |
Member Data Documentation
◆ value
|
protected |
The documentation for this class was generated from the following files:
- include/openjaus/model/fields/UnsignedByte.h
- src/openjaus/model/fields/UnsignedByte.cpp