openjaus::ugv::BatteryStatusRecord Class Reference

#include <BatteryStatusRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions
	BatteryStatusRecord ()
	BatteryStatusRecord (const BatteryStatusRecord &source)
	~BatteryStatusRecord ()
void	copy (BatteryStatusRecord &source)
virtual int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length (void)
	Serializes object to internal transport buffer. More...
std::string	toXml (unsigned char ojIndentLevel=0) const
void	setPresenceVector (uint8_t value)
uint8_t	getPresenceVector (void) const
bool	isChargeRemainingEnabled (void) const
void	enableChargeRemaining (void)
void	disableChargeRemaining (void)
bool	isVoltageEnabled (void) const
void	enableVoltage (void)
void	disableVoltage (void)
bool	isCurrentDrawEnabled (void) const
void	enableCurrentDraw (void)
void	disableCurrentDraw (void)
bool	isBatteryTempEnabled (void) const
void	enableBatteryTemp (void)
void	disableBatteryTemp (void)
bool	isBatteryHoursEnabled (void) const
void	enableBatteryHours (void)
void	disableBatteryHours (void)
double	getChargeRemaining_percent (void)
bool	setChargeRemaining_percent (double value)
double	getVoltage_V (void)
bool	setVoltage_V (double value)
double	getCurrentDraw_A (void)
bool	setCurrentDraw_A (double value)
double	getBatteryTemp_degC (void)
bool	setBatteryTemp_degC (double value)
uint32_t	getBatteryHours_hour (void)
bool	setBatteryHours_hour (uint32_t value)
Public Member Functions inherited from openjaus::model::fields::Record
	Record ()
virtual	~Record ()
const std::vector< Field *> &	getFields () const
	Accessor to get the value of fields. More...
bool	setFields (const Field &fields)
	Accessor to set value of fields. 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 ()

Static Public Attributes
static const uint8_t	PV_ALL_FIELDS = 0xFF
static const uint8_t	PV_NO_FIELDS = 0x0
static const uint8_t	PV_CHARGEREMAINING = 0x1
static const uint8_t	PV_VOLTAGE = 0x2
static const uint8_t	PV_CURRENTDRAW = 0x4
static const uint8_t	PV_BATTERYTEMP = 0x8
static const uint8_t	PV_BATTERYHOURS = 0x10

Protected Attributes
ChargeRemainingScaledInteger	chargeRemaining_percent
VoltageScaledInteger	voltage_V
CurrentDrawScaledInteger	currentDraw_A
BatteryTempScaledInteger	batteryTemp_degC
model::fields::UnsignedInteger	batteryHours_hour
uint8_t	presenceVector
Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *>	fields
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Constructor & Destructor Documentation

BatteryStatusRecord() [1/2]

openjaus::ugv::BatteryStatusRecord::BatteryStatusRecord

(

)

BatteryStatusRecord() [2/2]

openjaus::ugv::BatteryStatusRecord::BatteryStatusRecord

(

const BatteryStatusRecord &

source

)

~BatteryStatusRecord()

openjaus::ugv::BatteryStatusRecord::~BatteryStatusRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv::BatteryStatusRecord::copy

(

BatteryStatusRecord &

source

)

disableBatteryHours()

void openjaus::ugv::BatteryStatusRecord::disableBatteryHours

(

void

)

disableBatteryTemp()

void openjaus::ugv::BatteryStatusRecord::disableBatteryTemp

(

void

)

disableChargeRemaining()

void openjaus::ugv::BatteryStatusRecord::disableChargeRemaining

(

void

)

disableCurrentDraw()

void openjaus::ugv::BatteryStatusRecord::disableCurrentDraw

(

void

)

disableVoltage()

void openjaus::ugv::BatteryStatusRecord::disableVoltage

(

void

)

enableBatteryHours()

void openjaus::ugv::BatteryStatusRecord::enableBatteryHours

(

void

)

enableBatteryTemp()

void openjaus::ugv::BatteryStatusRecord::enableBatteryTemp

(

void

)

enableChargeRemaining()

void openjaus::ugv::BatteryStatusRecord::enableChargeRemaining

(

void

)

enableCurrentDraw()

void openjaus::ugv::BatteryStatusRecord::enableCurrentDraw

(

void

)

enableVoltage()

void openjaus::ugv::BatteryStatusRecord::enableVoltage

(

void

)

from()

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

virtual

Parameters

src

Reimplemented from openjaus::model::fields::Record.

getBatteryHours_hour()

uint32_t openjaus::ugv::BatteryStatusRecord::getBatteryHours_hour

(

void

)

getBatteryTemp_degC()

double openjaus::ugv::BatteryStatusRecord::getBatteryTemp_degC

(

void

)

getChargeRemaining_percent()

double openjaus::ugv::BatteryStatusRecord::getChargeRemaining_percent

(

void

)

getCurrentDraw_A()

double openjaus::ugv::BatteryStatusRecord::getCurrentDraw_A

(

void

)

getPresenceVector()

uint8_t openjaus::ugv::BatteryStatusRecord::getPresenceVector

(

void

)

const

getVoltage_V()

double openjaus::ugv::BatteryStatusRecord::getVoltage_V

(

void

)

isBatteryHoursEnabled()

bool openjaus::ugv::BatteryStatusRecord::isBatteryHoursEnabled

(

void

)

const

isBatteryTempEnabled()

bool openjaus::ugv::BatteryStatusRecord::isBatteryTempEnabled

(

void

)

const

isChargeRemainingEnabled()

bool openjaus::ugv::BatteryStatusRecord::isChargeRemainingEnabled

(

void

)

const

isCurrentDrawEnabled()

bool openjaus::ugv::BatteryStatusRecord::isCurrentDrawEnabled

(

void

)

const

isVoltageEnabled()

bool openjaus::ugv::BatteryStatusRecord::isVoltageEnabled

(

void

)

const

length()

int openjaus::ugv::BatteryStatusRecord::length ( void  )

virtual

Reimplemented from openjaus::model::fields::Record.

setBatteryHours_hour()

bool openjaus::ugv::BatteryStatusRecord::setBatteryHours_hour

(

uint32_t

value

)

setBatteryTemp_degC()

bool openjaus::ugv::BatteryStatusRecord::setBatteryTemp_degC

(

double

value

)

setChargeRemaining_percent()

bool openjaus::ugv::BatteryStatusRecord::setChargeRemaining_percent

(

double

value

)

setCurrentDraw_A()

bool openjaus::ugv::BatteryStatusRecord::setCurrentDraw_A

(

double

value

)

setPresenceVector()

void openjaus::ugv::BatteryStatusRecord::setPresenceVector

(

uint8_t

value

)

setVoltage_V()

bool openjaus::ugv::BatteryStatusRecord::setVoltage_V

(

double

value

)

to()

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

virtual

Parameters

dst

Reimplemented from openjaus::model::fields::Record.

toXml()

std::string openjaus::ugv::BatteryStatusRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

batteryHours_hour

model::fields::UnsignedInteger openjaus::ugv::BatteryStatusRecord::batteryHours_hour

protected

batteryTemp_degC

BatteryTempScaledInteger openjaus::ugv::BatteryStatusRecord::batteryTemp_degC

protected

chargeRemaining_percent

ChargeRemainingScaledInteger openjaus::ugv::BatteryStatusRecord::chargeRemaining_percent

protected

currentDraw_A

CurrentDrawScaledInteger openjaus::ugv::BatteryStatusRecord::currentDraw_A

protected

presenceVector

uint8_t openjaus::ugv::BatteryStatusRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_ALL_FIELDS = 0xFF

static

PV_BATTERYHOURS

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_BATTERYHOURS = 0x10

static

PV_BATTERYTEMP

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_BATTERYTEMP = 0x8

static

PV_CHARGEREMAINING

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_CHARGEREMAINING = 0x1

static

PV_CURRENTDRAW

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_CURRENTDRAW = 0x4

static

PV_NO_FIELDS

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_NO_FIELDS = 0x0

static

PV_VOLTAGE

const uint8_t openjaus::ugv::BatteryStatusRecord::PV_VOLTAGE = 0x2

static

voltage_V

VoltageScaledInteger openjaus::ugv::BatteryStatusRecord::voltage_V

protected

---

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

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