OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
openjaus::core_v1_1::services::ConfigurationSettings Class Reference

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

#include <ConfigurationSettings.h>

Inherits openjaus::core_v1_1::services::ConfigurationSettingsInterface.

Public Member Functions

virtual ~ConfigurationSettings ()
 
ConfigurationSettingsInterface::AddressMode getAddressMode ()
 
void setAddressMode (ConfigurationSettingsInterface::AddressMode value)
 
uint16 getSubsystemId ()
 
void setSubsystemId (uint16 value)
 
uint8 getNodeId ()
 
void setNodeId (uint8 value)
 
uint8 getComponentId ()
 
void setComponentId (uint8 value)
 
int getDynamicInterval_ms ()
 
void setDynamicInterval_ms (int value)
 
bool useNextAvailableComponentId ()
 
void setUseNextAvailableComponentId (bool value)
 
bool areValid ()
 
- Public Member Functions inherited from openjaus::core_v1_1::services::ConfigurationSettingsInterface
 ConfigurationSettingsInterface ()
 
virtual ~ConfigurationSettingsInterface ()
 

Static Public Member Functions

static ConfigurationSettings * loadFromConfFile (model::ComponentInfo *const component)
 
static ConfigurationSettings * loadFromConfFile (const std::string &componentName)
 

Private Member Functions

 ConfigurationSettings ()
 
bool areStaticSettingsValid ()
 
bool areNode1HeartbeatSettingsValid ()
 
bool areOjDynamicSettingsValid ()
 
bool isSubsystemIdValid ()
 
bool isNodeIdValid ()
 
bool isComponentIdValid ()
 

Static Private Member Functions

static void loadAddressMode (ConfigurationSettings *settings)
 
static void loadStaticModeSettings (ConfigurationSettings *settings, const std::string &name)
 
static void loadNode1HeartbeatSettings (ConfigurationSettings *settings, const std::string &name)
 
static void loadOpenjausDiscoverySettings (ConfigurationSettings *settings)
 
static void loadNodeId (ConfigurationSettings *settings)
 
static void loadComponentId (ConfigurationSettings *settings, const std::string &name)
 
static void verifySettingsAndThrowIfError (ConfigurationSettings *settings)
 
static bool isInRangeInclusive (int value, int minValue, int maxValue)
 

Private Attributes

ConfigurationSettingsInterface::AddressMode addressMode
 
uint16 subsystemId
 
uint8 nodeId
 
uint8 componentId
 
int dynamicInterval_ms
 
bool useNextAvailableCmptId
 

Additional Inherited Members

- Public Types inherited from openjaus::core_v1_1::services::ConfigurationSettingsInterface
enum  AddressMode {
  UNKNOWN, STATIC, NODE1HEARTBEAT, OJDYNAMIC,
  OVERRIDE
}
 

Detailed Description

Constructor & Destructor Documentation

◆ ~ConfigurationSettings()

openjaus::core_v1_1::services::ConfigurationSettings::~ConfigurationSettings ( )
virtual

◆ ConfigurationSettings()

openjaus::core_v1_1::services::ConfigurationSettings::ConfigurationSettings ( )
private

Member Function Documentation

◆ areNode1HeartbeatSettingsValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::areNode1HeartbeatSettingsValid ( )
private

◆ areOjDynamicSettingsValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::areOjDynamicSettingsValid ( )
private

◆ areStaticSettingsValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::areStaticSettingsValid ( )
private

◆ areValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::areValid ( )

◆ getAddressMode()

ConfigurationSettingsInterface::AddressMode openjaus::core_v1_1::services::ConfigurationSettings::getAddressMode ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ getComponentId()

uint8 openjaus::core_v1_1::services::ConfigurationSettings::getComponentId ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ getDynamicInterval_ms()

int openjaus::core_v1_1::services::ConfigurationSettings::getDynamicInterval_ms ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ getNodeId()

uint8 openjaus::core_v1_1::services::ConfigurationSettings::getNodeId ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ getSubsystemId()

uint16 openjaus::core_v1_1::services::ConfigurationSettings::getSubsystemId ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ isComponentIdValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::isComponentIdValid ( )
private

◆ isInRangeInclusive()

bool openjaus::core_v1_1::services::ConfigurationSettings::isInRangeInclusive ( int  value,
int  minValue,
int  maxValue 
)
staticprivate

◆ isNodeIdValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::isNodeIdValid ( )
private

◆ isSubsystemIdValid()

bool openjaus::core_v1_1::services::ConfigurationSettings::isSubsystemIdValid ( )
private

◆ loadAddressMode()

void openjaus::core_v1_1::services::ConfigurationSettings::loadAddressMode ( ConfigurationSettings *  settings)
staticprivate

◆ loadComponentId()

void openjaus::core_v1_1::services::ConfigurationSettings::loadComponentId ( ConfigurationSettings *  settings,
const std::string &  name 
)
staticprivate

◆ loadFromConfFile() [1/2]

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

◆ loadFromConfFile() [2/2]

ConfigurationSettings * openjaus::core_v1_1::services::ConfigurationSettings::loadFromConfFile ( const std::string &  componentName)
static

◆ loadNode1HeartbeatSettings()

void openjaus::core_v1_1::services::ConfigurationSettings::loadNode1HeartbeatSettings ( ConfigurationSettings *  settings,
const std::string &  name 
)
staticprivate

◆ loadNodeId()

void openjaus::core_v1_1::services::ConfigurationSettings::loadNodeId ( ConfigurationSettings *  settings)
staticprivate

◆ loadOpenjausDiscoverySettings()

void openjaus::core_v1_1::services::ConfigurationSettings::loadOpenjausDiscoverySettings ( ConfigurationSettings *  settings)
staticprivate

◆ loadStaticModeSettings()

void openjaus::core_v1_1::services::ConfigurationSettings::loadStaticModeSettings ( ConfigurationSettings *  settings,
const std::string &  name 
)
staticprivate

◆ setAddressMode()

void openjaus::core_v1_1::services::ConfigurationSettings::setAddressMode ( ConfigurationSettingsInterface::AddressMode  value)

◆ setComponentId()

void openjaus::core_v1_1::services::ConfigurationSettings::setComponentId ( uint8  value)

◆ setDynamicInterval_ms()

void openjaus::core_v1_1::services::ConfigurationSettings::setDynamicInterval_ms ( int  value)

◆ setNodeId()

void openjaus::core_v1_1::services::ConfigurationSettings::setNodeId ( uint8  value)

◆ setSubsystemId()

void openjaus::core_v1_1::services::ConfigurationSettings::setSubsystemId ( uint16  value)

◆ setUseNextAvailableComponentId()

void openjaus::core_v1_1::services::ConfigurationSettings::setUseNextAvailableComponentId ( bool  value)

◆ useNextAvailableComponentId()

bool openjaus::core_v1_1::services::ConfigurationSettings::useNextAvailableComponentId ( )
virtual

Implements openjaus::core_v1_1::services::ConfigurationSettingsInterface.

◆ verifySettingsAndThrowIfError()

void openjaus::core_v1_1::services::ConfigurationSettings::verifySettingsAndThrowIfError ( ConfigurationSettings *  settings)
staticprivate

Member Data Documentation

◆ addressMode

ConfigurationSettingsInterface::AddressMode openjaus::core_v1_1::services::ConfigurationSettings::addressMode
private

◆ componentId

uint8 openjaus::core_v1_1::services::ConfigurationSettings::componentId
private

◆ dynamicInterval_ms

int openjaus::core_v1_1::services::ConfigurationSettings::dynamicInterval_ms
private

◆ nodeId

uint8 openjaus::core_v1_1::services::ConfigurationSettings::nodeId
private

◆ subsystemId

uint16 openjaus::core_v1_1::services::ConfigurationSettings::subsystemId
private

◆ useNextAvailableCmptId

bool openjaus::core_v1_1::services::ConfigurationSettings::useNextAvailableCmptId
private
The documentation for this class was generated from the following files: