#include <AnnunciatorTypesBitField.h>

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

Public Member Functions
	AnnunciatorTypesBitField ()

	~AnnunciatorTypesBitField ()

bool	setHorn (bool value)

bool	getHorn (void) const

bool	setSiren (bool value)

bool	getSiren (void) const

bool	setBackup (bool value)

bool	getBackup (void) const

bool	setVariable1 (bool value)

bool	getVariable1 (void) const

bool	setVariable2 (bool value)

bool	getVariable2 (void) const

bool	setReserved (long value)

long	getReserved (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 (AnnunciatorTypesBitField &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	horn

bool	siren

bool	backup

bool	variable1

bool	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 = 0x1

static const long	SIREN_START_BIT = 1

static const long	SIREN_BIT_MASK = 0x1

static const long	BACKUP_START_BIT = 2

static const long	BACKUP_BIT_MASK = 0x1

static const long	VARIABLE1_START_BIT = 3

static const long	VARIABLE1_BIT_MASK = 0x1

static const long	VARIABLE2_START_BIT = 4

static const long	VARIABLE2_BIT_MASK = 0x1

static const long	RESERVED_START_BIT = 5

static const long	RESERVED_BIT_MASK = 0x7

static const long	RESERVED_MIN_VALUE = 0

static const long	RESERVED_MAX_VALUE = 7

Constructor & Destructor Documentation

◆ AnnunciatorTypesBitField()

openjaus::ugv_v1_0::AnnunciatorTypesBitField::AnnunciatorTypesBitField ( )

◆ ~AnnunciatorTypesBitField()

openjaus::ugv_v1_0::AnnunciatorTypesBitField::~AnnunciatorTypesBitField ( )

Member Function Documentation

◆ copy()

void openjaus::ugv_v1_0::AnnunciatorTypesBitField::copy ( AnnunciatorTypesBitField & source )

◆ from()

uint64 openjaus::ugv_v1_0::AnnunciatorTypesBitField::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.

◆ getBackup()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::getBackup ( void ) const

◆ getHorn()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::getHorn ( void ) const

◆ getIntegerValue()

uint8_t openjaus::ugv_v1_0::AnnunciatorTypesBitField::getIntegerValue ( void ) const

◆ getReserved()

long openjaus::ugv_v1_0::AnnunciatorTypesBitField::getReserved ( void ) const

◆ getSiren()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::getSiren ( void ) const

◆ getVariable1()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::getVariable1 ( void ) const

◆ getVariable2()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::getVariable2 ( void ) const

◆ length()

uint64 openjaus::ugv_v1_0::AnnunciatorTypesBitField::length ( ) const

virtual

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

◆ setBackup()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setBackup ( bool value )

◆ setHorn()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setHorn ( bool value )

◆ setIntegerValue()

void openjaus::ugv_v1_0::AnnunciatorTypesBitField::setIntegerValue ( uint8_t value )

◆ setReserved()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setReserved ( long value )

◆ setSiren()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setSiren ( bool value )

◆ setVariable1()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setVariable1 ( bool value )

◆ setVariable2()

bool openjaus::ugv_v1_0::AnnunciatorTypesBitField::setVariable2 ( bool value )

◆ to()

uint64 openjaus::ugv_v1_0::AnnunciatorTypesBitField::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

const long openjaus::ugv_v1_0::AnnunciatorTypesBitField::VARIABLE2_START_BIT = 4

staticprotected

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

include/openjaus/ugv_v1_0/Triggers/Fields/AnnunciatorTypesBitField.h
src/openjaus/ugv_v1_0/Triggers/Fields/AnnunciatorTypesBitField.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ AnnunciatorTypesBitField()

◆ ~AnnunciatorTypesBitField()

Member Function Documentation

◆ copy()

◆ from()

◆ getBackup()

◆ getHorn()

◆ getIntegerValue()

◆ getReserved()

◆ getSiren()

◆ getVariable1()

◆ getVariable2()

◆ length()

◆ setBackup()

◆ setHorn()

◆ setIntegerValue()

◆ setReserved()

◆ setSiren()

◆ setVariable1()

◆ setVariable2()

◆ to()

◆ toXml()

Member Data Documentation

◆ backup

◆ BACKUP_BIT_MASK

◆ BACKUP_START_BIT

◆ horn

◆ HORN_BIT_MASK

◆ HORN_START_BIT

◆ reserved

◆ RESERVED_BIT_MASK

◆ RESERVED_MAX_VALUE

◆ RESERVED_MIN_VALUE

◆ RESERVED_START_BIT

◆ siren

◆ SIREN_BIT_MASK

◆ SIREN_START_BIT

◆ variable1

◆ VARIABLE1_BIT_MASK

◆ VARIABLE1_START_BIT

◆ variable2

◆ VARIABLE2_BIT_MASK

◆ VARIABLE2_START_BIT