OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
openjaus::environment_v1_0::SupportedCompressionBitField Class Reference

#include <SupportedCompressionBitField.h>

Inherits openjaus::model::fields::BitField.

Public Member Functions

 SupportedCompressionBitField ()
 
 ~SupportedCompressionBitField ()
 
bool setNoCompression (bool value)
 
bool getNoCompression (void) const
 
bool setDEFLATE (bool value)
 
bool getDEFLATE (void) const
 
bool setBzip2 (bool value)
 
bool getBzip2 (void) const
 
bool setLZMA (bool value)
 
bool getLZMA (void) const
 
uint8_t getIntegerValue (void) const
 
void setIntegerValue (uint8_t value)
 
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...
 
void copy (SupportedCompressionBitField &source)
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
- Public Member Functions inherited from openjaus::model::fields::BitField
 BitField ()
 
virtual ~BitField ()
 
long getDefaultValue () const
 Accessor to get the value of defaultValue. More...
 
bool setDefaultValue (long defaultValue)
 Accessor to set value of defaultValue. More...
 
uint64_t getValue () const
 Accessor to get the value of value. More...
 
bool setValue (uint64_t value)
 Accessor to set value of value. More...
 
TypesUnsigned getSize () const
 Accessor to get the value of size. More...
 
bool setSize (TypesUnsigned size)
 Accessor to set value of size. More...
 
const std::vector< BitFieldItem *> & getItems () const
 Accessor to get the value of items. More...
 
bool setItems (const BitFieldItem &items)
 Accessor to set value of items. 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

bool noCompression
 
bool dEFLATE
 
bool bzip2
 
bool lZMA
 
- Protected Attributes inherited from openjaus::model::fields::BitField
long defaultValue
 
uint64_t value
 
TypesUnsigned size
 
std::vector< BitFieldItem *> items
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Static Protected Attributes

static const long NOCOMPRESSION_START_BIT = 0
 
static const long NOCOMPRESSION_BIT_MASK = 0x1
 
static const long DEFLATE_START_BIT = 1
 
static const long DEFLATE_BIT_MASK = 0x1
 
static const long BZIP2_START_BIT = 2
 
static const long BZIP2_BIT_MASK = 0x1
 
static const long LZMA_START_BIT = 3
 
static const long LZMA_BIT_MASK = 0x1
 

Constructor & Destructor Documentation

◆ SupportedCompressionBitField()

openjaus::environment_v1_0::SupportedCompressionBitField::SupportedCompressionBitField ( )

◆ ~SupportedCompressionBitField()

openjaus::environment_v1_0::SupportedCompressionBitField::~SupportedCompressionBitField ( )

Member Function Documentation

◆ copy()

void openjaus::environment_v1_0::SupportedCompressionBitField::copy ( SupportedCompressionBitField source)

◆ from()

uint64 openjaus::environment_v1_0::SupportedCompressionBitField::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::BitField.

◆ getBzip2()

bool openjaus::environment_v1_0::SupportedCompressionBitField::getBzip2 ( void  ) const

◆ getDEFLATE()

bool openjaus::environment_v1_0::SupportedCompressionBitField::getDEFLATE ( void  ) const

◆ getIntegerValue()

uint8_t openjaus::environment_v1_0::SupportedCompressionBitField::getIntegerValue ( void  ) const

◆ getLZMA()

bool openjaus::environment_v1_0::SupportedCompressionBitField::getLZMA ( void  ) const

◆ getNoCompression()

bool openjaus::environment_v1_0::SupportedCompressionBitField::getNoCompression ( void  ) const

◆ length()

uint64 openjaus::environment_v1_0::SupportedCompressionBitField::length ( ) const
virtual

Reimplemented from openjaus::model::fields::BitField.

◆ setBzip2()

bool openjaus::environment_v1_0::SupportedCompressionBitField::setBzip2 ( bool  value)

◆ setDEFLATE()

bool openjaus::environment_v1_0::SupportedCompressionBitField::setDEFLATE ( bool  value)

◆ setIntegerValue()

void openjaus::environment_v1_0::SupportedCompressionBitField::setIntegerValue ( uint8_t  value)

◆ setLZMA()

bool openjaus::environment_v1_0::SupportedCompressionBitField::setLZMA ( bool  value)

◆ setNoCompression()

bool openjaus::environment_v1_0::SupportedCompressionBitField::setNoCompression ( bool  value)

◆ to()

uint64 openjaus::environment_v1_0::SupportedCompressionBitField::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::BitField.

◆ toXml()

std::string openjaus::environment_v1_0::SupportedCompressionBitField::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ bzip2

bool openjaus::environment_v1_0::SupportedCompressionBitField::bzip2
protected

◆ BZIP2_BIT_MASK

const long openjaus::environment_v1_0::SupportedCompressionBitField::BZIP2_BIT_MASK = 0x1
staticprotected

◆ BZIP2_START_BIT

const long openjaus::environment_v1_0::SupportedCompressionBitField::BZIP2_START_BIT = 2
staticprotected

◆ dEFLATE

bool openjaus::environment_v1_0::SupportedCompressionBitField::dEFLATE
protected

◆ DEFLATE_BIT_MASK

const long openjaus::environment_v1_0::SupportedCompressionBitField::DEFLATE_BIT_MASK = 0x1
staticprotected

◆ DEFLATE_START_BIT

const long openjaus::environment_v1_0::SupportedCompressionBitField::DEFLATE_START_BIT = 1
staticprotected

◆ lZMA

bool openjaus::environment_v1_0::SupportedCompressionBitField::lZMA
protected

◆ LZMA_BIT_MASK

const long openjaus::environment_v1_0::SupportedCompressionBitField::LZMA_BIT_MASK = 0x1
staticprotected

◆ LZMA_START_BIT

const long openjaus::environment_v1_0::SupportedCompressionBitField::LZMA_START_BIT = 3
staticprotected

◆ noCompression

bool openjaus::environment_v1_0::SupportedCompressionBitField::noCompression
protected

◆ NOCOMPRESSION_BIT_MASK

const long openjaus::environment_v1_0::SupportedCompressionBitField::NOCOMPRESSION_BIT_MASK = 0x1
staticprotected

◆ NOCOMPRESSION_START_BIT

const long openjaus::environment_v1_0::SupportedCompressionBitField::NOCOMPRESSION_START_BIT = 0
staticprotected

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