openjaus::core::services::ConfigurationSettings Class Reference

Encapsulates the configuration settings needed by the Configuration service. More...

#include <ConfigurationSettings.h>

Inherits openjaus::core::services::ConfigurationSettingsInterface.

Public Member Functions
virtual	~ConfigurationSettings ()
ConfigurationSettingsInterface::AddressMode	getAddressMode ()
uint8	getSubsystemId ()
uint8	getNodeId ()
uint8	getComponentId ()
int	getDynamicInterval_ms ()
bool	useNextAvailableComponentId ()
Public Member Functions inherited from openjaus::core::services::ConfigurationSettingsInterface
	ConfigurationSettingsInterface ()
virtual	~ConfigurationSettingsInterface ()

Static Public Member Functions
static ConfigurationSettings *	loadFromConfFile (model::ComponentInfo *const component)

Private Member Functions
	ConfigurationSettings (model::ComponentInfo *const component)
void	verifySettingsAndThrowOnError ()
void	checkStaticSettingsAndLogErrors ()
void	checkNode1HeartbeatSettingsAndLogErrors ()
void	checkDynamicSettingsAndLogErrors ()
void	checkSubsystemIdAndLogError ()
void	checkNodeIdAndLogError ()
bool	idOutOfRange (uint8 id)

Static Private Member Functions
static ConfigurationSettingsInterface::AddressMode	loadAddressMode ()

Private Attributes
model::ComponentInfo *	component
ConfigurationSettingsInterface::AddressMode	addressMode
uint8	subsystemId
uint8	nodeId
int	dynamicInterval_ms
bool	useNextAvailableCmptId
bool	settingsValid

Additional Inherited Members
Public Types inherited from openjaus::core::services::ConfigurationSettingsInterface
enum	AddressMode { STATIC, NODE1HEARTBEAT, DYNAMIC, OVERRIDE }

Detailed Description

Constructor & Destructor Documentation

~ConfigurationSettings()

openjaus::core::services::ConfigurationSettings::~ConfigurationSettings ( )

virtual

ConfigurationSettings()

openjaus::core::services::ConfigurationSettings::ConfigurationSettings ( model::ComponentInfo *const  component )

private

Member Function Documentation

checkDynamicSettingsAndLogErrors()

void openjaus::core::services::ConfigurationSettings::checkDynamicSettingsAndLogErrors ( )

private

checkNode1HeartbeatSettingsAndLogErrors()

void openjaus::core::services::ConfigurationSettings::checkNode1HeartbeatSettingsAndLogErrors ( )

private

checkNodeIdAndLogError()

void openjaus::core::services::ConfigurationSettings::checkNodeIdAndLogError ( )

private

checkStaticSettingsAndLogErrors()

void openjaus::core::services::ConfigurationSettings::checkStaticSettingsAndLogErrors ( )

private

checkSubsystemIdAndLogError()

void openjaus::core::services::ConfigurationSettings::checkSubsystemIdAndLogError ( )

private

getAddressMode()

ConfigurationSettingsInterface::AddressMode openjaus::core::services::ConfigurationSettings::getAddressMode ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

getComponentId()

uint8 openjaus::core::services::ConfigurationSettings::getComponentId ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

getDynamicInterval_ms()

int openjaus::core::services::ConfigurationSettings::getDynamicInterval_ms ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

getNodeId()

uint8 openjaus::core::services::ConfigurationSettings::getNodeId ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

getSubsystemId()

uint8 openjaus::core::services::ConfigurationSettings::getSubsystemId ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

idOutOfRange()

bool openjaus::core::services::ConfigurationSettings::idOutOfRange ( uint8  id )

private

loadAddressMode()

ConfigurationSettingsInterface::AddressMode openjaus::core::services::ConfigurationSettings::loadAddressMode ( )

staticprivate

loadFromConfFile()

ConfigurationSettings * openjaus::core::services::ConfigurationSettings::loadFromConfFile ( model::ComponentInfo *const  component )

static

useNextAvailableComponentId()

bool openjaus::core::services::ConfigurationSettings::useNextAvailableComponentId ( )

virtual

Implements openjaus::core::services::ConfigurationSettingsInterface.

verifySettingsAndThrowOnError()

void openjaus::core::services::ConfigurationSettings::verifySettingsAndThrowOnError ( )

private

Member Data Documentation

addressMode

ConfigurationSettingsInterface::AddressMode openjaus::core::services::ConfigurationSettings::addressMode

private

component

model::ComponentInfo* openjaus::core::services::ConfigurationSettings::component

private

dynamicInterval_ms

int openjaus::core::services::ConfigurationSettings::dynamicInterval_ms

private

nodeId

uint8 openjaus::core::services::ConfigurationSettings::nodeId

private

settingsValid

bool openjaus::core::services::ConfigurationSettings::settingsValid

private

subsystemId

uint8 openjaus::core::services::ConfigurationSettings::subsystemId

private

useNextAvailableCmptId

bool openjaus::core::services::ConfigurationSettings::useNextAvailableCmptId

private

---

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

• include/openjaus/core/Services/Settings/ConfigurationSettings.h
• src/openjaus/core/Services/Settings/ConfigurationSettings.cpp