openjaus::ugv::AnnunciatorTypesBitField Class Reference

#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 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 (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
virtual	~Transportable ()
	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::AnnunciatorTypesBitField::AnnunciatorTypesBitField

(

)

~AnnunciatorTypesBitField()

openjaus::ugv::AnnunciatorTypesBitField::~AnnunciatorTypesBitField

(

)

Member Function Documentation

copy()

void openjaus::ugv::AnnunciatorTypesBitField::copy

(

AnnunciatorTypesBitField &

source

)

from()

int openjaus::ugv::AnnunciatorTypesBitField::from ( system::Buffer *  src )

virtual

Parameters

src

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

getBackup()

bool openjaus::ugv::AnnunciatorTypesBitField::getBackup

(

void

)

const

getHorn()

bool openjaus::ugv::AnnunciatorTypesBitField::getHorn

(

void

)

const

getIntegerValue()

uint8_t openjaus::ugv::AnnunciatorTypesBitField::getIntegerValue

(

void

)

const

getReserved()

long openjaus::ugv::AnnunciatorTypesBitField::getReserved

(

void

)

const

getSiren()

bool openjaus::ugv::AnnunciatorTypesBitField::getSiren

(

void

)

const

getVariable1()

bool openjaus::ugv::AnnunciatorTypesBitField::getVariable1

(

void

)

const

getVariable2()

bool openjaus::ugv::AnnunciatorTypesBitField::getVariable2

(

void

)

const

length()

int openjaus::ugv::AnnunciatorTypesBitField::length ( )

virtual

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

setBackup()

bool openjaus::ugv::AnnunciatorTypesBitField::setBackup

(

bool

value

)

setHorn()

bool openjaus::ugv::AnnunciatorTypesBitField::setHorn

(

bool

value

)

setIntegerValue()

void openjaus::ugv::AnnunciatorTypesBitField::setIntegerValue

(

uint8_t

value

)

setReserved()

bool openjaus::ugv::AnnunciatorTypesBitField::setReserved

(

long

value

)

setSiren()

bool openjaus::ugv::AnnunciatorTypesBitField::setSiren

(

bool

value

)

setVariable1()

bool openjaus::ugv::AnnunciatorTypesBitField::setVariable1

(

bool

value

)

setVariable2()

bool openjaus::ugv::AnnunciatorTypesBitField::setVariable2

(

bool

value

)

to()

int openjaus::ugv::AnnunciatorTypesBitField::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::ugv::AnnunciatorTypesBitField::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

backup

bool openjaus::ugv::AnnunciatorTypesBitField::backup

protected

BACKUP_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::BACKUP_BIT_MASK = 0x1

staticprotected

BACKUP_START_BIT

const long openjaus::ugv::AnnunciatorTypesBitField::BACKUP_START_BIT = 2

staticprotected

horn

bool openjaus::ugv::AnnunciatorTypesBitField::horn

protected

HORN_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::HORN_BIT_MASK = 0x1

staticprotected

HORN_START_BIT

const long openjaus::ugv::AnnunciatorTypesBitField::HORN_START_BIT = 0

staticprotected

reserved

long openjaus::ugv::AnnunciatorTypesBitField::reserved

protected

RESERVED_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::RESERVED_BIT_MASK = 0x7

staticprotected

RESERVED_MAX_VALUE

const long openjaus::ugv::AnnunciatorTypesBitField::RESERVED_MAX_VALUE = 7

staticprotected

RESERVED_MIN_VALUE

const long openjaus::ugv::AnnunciatorTypesBitField::RESERVED_MIN_VALUE = 0

staticprotected

RESERVED_START_BIT

const long openjaus::ugv::AnnunciatorTypesBitField::RESERVED_START_BIT = 5

staticprotected

siren

bool openjaus::ugv::AnnunciatorTypesBitField::siren

protected

SIREN_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::SIREN_BIT_MASK = 0x1

staticprotected

SIREN_START_BIT

const long openjaus::ugv::AnnunciatorTypesBitField::SIREN_START_BIT = 1

staticprotected

variable1

bool openjaus::ugv::AnnunciatorTypesBitField::variable1

protected

VARIABLE1_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::VARIABLE1_BIT_MASK = 0x1

staticprotected

VARIABLE1_START_BIT

const long openjaus::ugv::AnnunciatorTypesBitField::VARIABLE1_START_BIT = 3

staticprotected

variable2

bool openjaus::ugv::AnnunciatorTypesBitField::variable2

protected

VARIABLE2_BIT_MASK

const long openjaus::ugv::AnnunciatorTypesBitField::VARIABLE2_BIT_MASK = 0x1

staticprotected

VARIABLE2_START_BIT

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

staticprotected

---

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

• include/openjaus/ugv/Triggers/Fields/AnnunciatorTypesBitField.h
• src/openjaus/ugv/Triggers/Fields/AnnunciatorTypesBitField.cpp