openjaus::ugv::BatteryCapabilitiesRecord Class Reference

#include <BatteryCapabilitiesRecord.h>

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

Public Member Functions
	BatteryCapabilitiesRecord ()
	BatteryCapabilitiesRecord (const BatteryCapabilitiesRecord &source)
	~BatteryCapabilitiesRecord ()
void	copy (BatteryCapabilitiesRecord &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	isNominalVoltageEnabled (void) const
void	enableNominalVoltage (void)
void	disableNominalVoltage (void)
bool	isMaxChargeEnabled (void) const
void	enableMaxCharge (void)
void	disableMaxCharge (void)
bool	isMaxCrankingAmpsEnabled (void) const
void	enableMaxCrankingAmps (void)
void	disableMaxCrankingAmps (void)
double	getNominalVoltage_V (void)
bool	setNominalVoltage_V (double value)
double	getMaxCharge_C (void)
bool	setMaxCharge_C (double value)
double	getMaxCrankingAmps_A (void)
bool	setMaxCrankingAmps_A (double 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_NOMINALVOLTAGE = 0x1
static const uint8_t	PV_MAXCHARGE = 0x2
static const uint8_t	PV_MAXCRANKINGAMPS = 0x4

Protected Attributes
NominalVoltageScaledInteger	nominalVoltage_V
MaxChargeScaledInteger	maxCharge_C
MaxCrankingAmpsScaledInteger	maxCrankingAmps_A
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

BatteryCapabilitiesRecord() [1/2]

openjaus::ugv::BatteryCapabilitiesRecord::BatteryCapabilitiesRecord

(

)

BatteryCapabilitiesRecord() [2/2]

openjaus::ugv::BatteryCapabilitiesRecord::BatteryCapabilitiesRecord

(

const BatteryCapabilitiesRecord &

source

)

~BatteryCapabilitiesRecord()

openjaus::ugv::BatteryCapabilitiesRecord::~BatteryCapabilitiesRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv::BatteryCapabilitiesRecord::copy

(

BatteryCapabilitiesRecord &

source

)

disableMaxCharge()

void openjaus::ugv::BatteryCapabilitiesRecord::disableMaxCharge

(

void

)

disableMaxCrankingAmps()

void openjaus::ugv::BatteryCapabilitiesRecord::disableMaxCrankingAmps

(

void

)

disableNominalVoltage()

void openjaus::ugv::BatteryCapabilitiesRecord::disableNominalVoltage

(

void

)

enableMaxCharge()

void openjaus::ugv::BatteryCapabilitiesRecord::enableMaxCharge

(

void

)

enableMaxCrankingAmps()

void openjaus::ugv::BatteryCapabilitiesRecord::enableMaxCrankingAmps

(

void

)

enableNominalVoltage()

void openjaus::ugv::BatteryCapabilitiesRecord::enableNominalVoltage

(

void

)

from()

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

virtual

Parameters

src

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

getMaxCharge_C()

double openjaus::ugv::BatteryCapabilitiesRecord::getMaxCharge_C

(

void

)

getMaxCrankingAmps_A()

double openjaus::ugv::BatteryCapabilitiesRecord::getMaxCrankingAmps_A

(

void

)

getNominalVoltage_V()

double openjaus::ugv::BatteryCapabilitiesRecord::getNominalVoltage_V

(

void

)

getPresenceVector()

uint8_t openjaus::ugv::BatteryCapabilitiesRecord::getPresenceVector

(

void

)

const

isMaxChargeEnabled()

bool openjaus::ugv::BatteryCapabilitiesRecord::isMaxChargeEnabled

(

void

)

const

isMaxCrankingAmpsEnabled()

bool openjaus::ugv::BatteryCapabilitiesRecord::isMaxCrankingAmpsEnabled

(

void

)

const

isNominalVoltageEnabled()

bool openjaus::ugv::BatteryCapabilitiesRecord::isNominalVoltageEnabled

(

void

)

const

length()

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

virtual

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

setMaxCharge_C()

bool openjaus::ugv::BatteryCapabilitiesRecord::setMaxCharge_C

(

double

value

)

setMaxCrankingAmps_A()

bool openjaus::ugv::BatteryCapabilitiesRecord::setMaxCrankingAmps_A

(

double

value

)

setNominalVoltage_V()

bool openjaus::ugv::BatteryCapabilitiesRecord::setNominalVoltage_V

(

double

value

)

setPresenceVector()

void openjaus::ugv::BatteryCapabilitiesRecord::setPresenceVector

(

uint8_t

value

)

to()

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

virtual

Parameters

dst

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

toXml()

std::string openjaus::ugv::BatteryCapabilitiesRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

maxCharge_C

MaxChargeScaledInteger openjaus::ugv::BatteryCapabilitiesRecord::maxCharge_C

protected

maxCrankingAmps_A

MaxCrankingAmpsScaledInteger openjaus::ugv::BatteryCapabilitiesRecord::maxCrankingAmps_A

protected

nominalVoltage_V

NominalVoltageScaledInteger openjaus::ugv::BatteryCapabilitiesRecord::nominalVoltage_V

protected

presenceVector

uint8_t openjaus::ugv::BatteryCapabilitiesRecord::presenceVector

protected

PV_ALL_FIELDS

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

static

PV_MAXCHARGE

const uint8_t openjaus::ugv::BatteryCapabilitiesRecord::PV_MAXCHARGE = 0x2

static

PV_MAXCRANKINGAMPS

const uint8_t openjaus::ugv::BatteryCapabilitiesRecord::PV_MAXCRANKINGAMPS = 0x4

static

PV_NO_FIELDS

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

static

PV_NOMINALVOLTAGE

const uint8_t openjaus::ugv::BatteryCapabilitiesRecord::PV_NOMINALVOLTAGE = 0x1

static

---

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

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