openjaus::ugv_v1_0::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 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 (void) const
	Gets the serialized length of this object. 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
	Transportable ()
virtual	~Transportable ()

Static Public Attributes
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
static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS | PV_NOMINALVOLTAGE | PV_MAXCHARGE | PV_MAXCRANKINGAMPS

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_v1_0::BatteryCapabilitiesRecord::BatteryCapabilitiesRecord

(

)

BatteryCapabilitiesRecord() [2/2]

openjaus::ugv_v1_0::BatteryCapabilitiesRecord::BatteryCapabilitiesRecord

(

const BatteryCapabilitiesRecord &

source

)

~BatteryCapabilitiesRecord()

openjaus::ugv_v1_0::BatteryCapabilitiesRecord::~BatteryCapabilitiesRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::copy

(

BatteryCapabilitiesRecord &

source

)

disableMaxCharge()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::disableMaxCharge

(

void

)

disableMaxCrankingAmps()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::disableMaxCrankingAmps

(

void

)

disableNominalVoltage()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::disableNominalVoltage

(

void

)

enableMaxCharge()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::enableMaxCharge

(

void

)

enableMaxCrankingAmps()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::enableMaxCrankingAmps

(

void

)

enableNominalVoltage()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::enableNominalVoltage

(

void

)

from()

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

getMaxCharge_C()

double openjaus::ugv_v1_0::BatteryCapabilitiesRecord::getMaxCharge_C

(

void

)

getMaxCrankingAmps_A()

double openjaus::ugv_v1_0::BatteryCapabilitiesRecord::getMaxCrankingAmps_A

(

void

)

getNominalVoltage_V()

double openjaus::ugv_v1_0::BatteryCapabilitiesRecord::getNominalVoltage_V

(

void

)

getPresenceVector()

uint8_t openjaus::ugv_v1_0::BatteryCapabilitiesRecord::getPresenceVector

(

void

)

const

isMaxChargeEnabled()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::isMaxChargeEnabled

(

void

)

const

isMaxCrankingAmpsEnabled()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::isMaxCrankingAmpsEnabled

(

void

)

const

isNominalVoltageEnabled()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::isNominalVoltageEnabled

(

void

)

const

length()

uint64 openjaus::ugv_v1_0::BatteryCapabilitiesRecord::length ( void  ) const

virtual

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

setMaxCharge_C()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::setMaxCharge_C

(

double

value

)

setMaxCrankingAmps_A()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::setMaxCrankingAmps_A

(

double

value

)

setNominalVoltage_V()

bool openjaus::ugv_v1_0::BatteryCapabilitiesRecord::setNominalVoltage_V

(

double

value

)

setPresenceVector()

void openjaus::ugv_v1_0::BatteryCapabilitiesRecord::setPresenceVector

(

uint8_t

value

)

to()

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

dst

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

toXml()

std::string openjaus::ugv_v1_0::BatteryCapabilitiesRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

maxCharge_C

MaxChargeScaledInteger openjaus::ugv_v1_0::BatteryCapabilitiesRecord::maxCharge_C

protected

maxCrankingAmps_A

MaxCrankingAmpsScaledInteger openjaus::ugv_v1_0::BatteryCapabilitiesRecord::maxCrankingAmps_A

protected

nominalVoltage_V

NominalVoltageScaledInteger openjaus::ugv_v1_0::BatteryCapabilitiesRecord::nominalVoltage_V

protected

presenceVector

uint8_t openjaus::ugv_v1_0::BatteryCapabilitiesRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::ugv_v1_0::BatteryCapabilitiesRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_NOMINALVOLTAGE | PV_MAXCHARGE | PV_MAXCRANKINGAMPS

static

PV_MAXCHARGE

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

static

PV_MAXCRANKINGAMPS

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

static

PV_NO_FIELDS

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

static

PV_NOMINALVOLTAGE

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

static

---

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

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