OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
openjaus::ugv::AnnunciatorTypesEnumBitField Class Reference

#include <AnnunciatorTypesEnumBitField.h>

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

Public Member Functions

 AnnunciatorTypesEnumBitField ()
 
 ~AnnunciatorTypesEnumBitField ()
 
bool setHorn (long value)
 
long getHorn (void) const
 
bool setSiren (long value)
 
long getSiren (void) const
 
bool setBackup (long value)
 
long getBackup (void) const
 
bool setVariable1 (long value)
 
long getVariable1 (void) const
 
bool setVariable2 (long value)
 
long getVariable2 (void) const
 
bool setReserved (long value)
 
long getReserved (void) const
 
uint32_t getIntegerValue (void) const
 
void setIntegerValue (uint32_t value)
 
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...
 
void copy (AnnunciatorTypesEnumBitField &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
virtual ~Transportable ()
 
 Transportable ()
 

Protected Attributes

long horn
 
long siren
 
long backup
 
long variable1
 
long variable2
 
long reserved
 
- 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 HORN_START_BIT = 0
 
static const long HORN_BIT_MASK = 0xF
 
static const long SIREN_START_BIT = 4
 
static const long SIREN_BIT_MASK = 0xF
 
static const long BACKUP_START_BIT = 8
 
static const long BACKUP_BIT_MASK = 0xF
 
static const long VARIABLE1_START_BIT = 12
 
static const long VARIABLE1_BIT_MASK = 0xF
 
static const long VARIABLE2_START_BIT = 16
 
static const long VARIABLE2_BIT_MASK = 0xF
 
static const long RESERVED_START_BIT = 20
 
static const long RESERVED_BIT_MASK = 0xFFF
 
static const long HORN_MIN_VALUE = 0
 
static const long HORN_MAX_VALUE = 15
 
static const long SIREN_MIN_VALUE = 0
 
static const long SIREN_MAX_VALUE = 15
 
static const long BACKUP_MIN_VALUE = 0
 
static const long BACKUP_MAX_VALUE = 15
 
static const long VARIABLE1_MIN_VALUE = 0
 
static const long VARIABLE1_MAX_VALUE = 15
 
static const long VARIABLE2_MIN_VALUE = 0
 
static const long VARIABLE2_MAX_VALUE = 15
 
static const long RESERVED_MIN_VALUE = 0
 
static const long RESERVED_MAX_VALUE = 2047
 

Constructor & Destructor Documentation

§ AnnunciatorTypesEnumBitField()

openjaus::ugv::AnnunciatorTypesEnumBitField::AnnunciatorTypesEnumBitField ( )

§ ~AnnunciatorTypesEnumBitField()

openjaus::ugv::AnnunciatorTypesEnumBitField::~AnnunciatorTypesEnumBitField ( )

Member Function Documentation

§ copy()

void openjaus::ugv::AnnunciatorTypesEnumBitField::copy ( AnnunciatorTypesEnumBitField &  source)

§ from()

int openjaus::ugv::AnnunciatorTypesEnumBitField::from ( system::Buffer *  src)
virtual
Parameters
src

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

§ getBackup()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getBackup ( void  ) const

§ getHorn()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getHorn ( void  ) const

§ getIntegerValue()

uint32_t openjaus::ugv::AnnunciatorTypesEnumBitField::getIntegerValue ( void  ) const

§ getReserved()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getReserved ( void  ) const

§ getSiren()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getSiren ( void  ) const

§ getVariable1()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getVariable1 ( void  ) const

§ getVariable2()

long openjaus::ugv::AnnunciatorTypesEnumBitField::getVariable2 ( void  ) const

§ length()

int openjaus::ugv::AnnunciatorTypesEnumBitField::length ( )
virtual

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

§ setBackup()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setBackup ( long  value)

§ setHorn()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setHorn ( long  value)

§ setIntegerValue()

void openjaus::ugv::AnnunciatorTypesEnumBitField::setIntegerValue ( uint32_t  value)

§ setReserved()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setReserved ( long  value)

§ setSiren()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setSiren ( long  value)

§ setVariable1()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setVariable1 ( long  value)

§ setVariable2()

bool openjaus::ugv::AnnunciatorTypesEnumBitField::setVariable2 ( long  value)

§ to()

int openjaus::ugv::AnnunciatorTypesEnumBitField::to ( system::Buffer *  dst)
virtual
Parameters
dst

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

§ toXml()

std::string openjaus::ugv::AnnunciatorTypesEnumBitField::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ backup

long openjaus::ugv::AnnunciatorTypesEnumBitField::backup
protected

§ BACKUP_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::BACKUP_BIT_MASK = 0xF
staticprotected

§ BACKUP_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::BACKUP_MAX_VALUE = 15
staticprotected

§ BACKUP_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::BACKUP_MIN_VALUE = 0
staticprotected

§ BACKUP_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::BACKUP_START_BIT = 8
staticprotected

§ horn

long openjaus::ugv::AnnunciatorTypesEnumBitField::horn
protected

§ HORN_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::HORN_BIT_MASK = 0xF
staticprotected

§ HORN_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::HORN_MAX_VALUE = 15
staticprotected

§ HORN_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::HORN_MIN_VALUE = 0
staticprotected

§ HORN_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::HORN_START_BIT = 0
staticprotected

§ reserved

long openjaus::ugv::AnnunciatorTypesEnumBitField::reserved
protected

§ RESERVED_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::RESERVED_BIT_MASK = 0xFFF
staticprotected

§ RESERVED_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::RESERVED_MAX_VALUE = 2047
staticprotected

§ RESERVED_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::RESERVED_MIN_VALUE = 0
staticprotected

§ RESERVED_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::RESERVED_START_BIT = 20
staticprotected

§ siren

long openjaus::ugv::AnnunciatorTypesEnumBitField::siren
protected

§ SIREN_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::SIREN_BIT_MASK = 0xF
staticprotected

§ SIREN_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::SIREN_MAX_VALUE = 15
staticprotected

§ SIREN_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::SIREN_MIN_VALUE = 0
staticprotected

§ SIREN_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::SIREN_START_BIT = 4
staticprotected

§ variable1

long openjaus::ugv::AnnunciatorTypesEnumBitField::variable1
protected

§ VARIABLE1_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE1_BIT_MASK = 0xF
staticprotected

§ VARIABLE1_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE1_MAX_VALUE = 15
staticprotected

§ VARIABLE1_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE1_MIN_VALUE = 0
staticprotected

§ VARIABLE1_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE1_START_BIT = 12
staticprotected

§ variable2

long openjaus::ugv::AnnunciatorTypesEnumBitField::variable2
protected

§ VARIABLE2_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE2_BIT_MASK = 0xF
staticprotected

§ VARIABLE2_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE2_MAX_VALUE = 15
staticprotected

§ VARIABLE2_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE2_MIN_VALUE = 0
staticprotected

§ VARIABLE2_START_BIT

const long openjaus::ugv::AnnunciatorTypesEnumBitField::VARIABLE2_START_BIT = 16
staticprotected
The documentation for this class was generated from the following files: