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::DiscoverySettings Class Reference

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

#include <DiscoverySettings.h>

Inherits openjaus::core_v1_1::services::DiscoverySettingsInterface.

Public Member Functions

 DiscoverySettings ()
 
virtual ~DiscoverySettings ()
 
bool isEnabled ()
 
void setEnabled (bool value)
 
std::string getSystemName ()
 
void setSystemName (std::string name)
 
std::string getSubsystemName ()
 
void setSubsystemName (std::string name)
 
std::string getNodeName ()
 
void setNodeName (std::string name)
 
std::string getComponentName ()
 
void setComponentName (std::string name)
 
DiscoveryType getSubsystemType ()
 
void setSubsystemType (DiscoveryType value)
 
DiscoveryType getNodeType ()
 
void setNodeType (DiscoveryType value)
 
DiscoveryType getComponentType ()
 
void setComponentType (DiscoveryType value)
 
- Public Member Functions inherited from openjaus::core_v1_1::services::DiscoverySettingsInterface
 DiscoverySettingsInterface ()
 
virtual ~DiscoverySettingsInterface ()
 

Static Public Member Functions

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

Private Member Functions

void verify ()
 

Static Private Member Functions

static DiscoveryType getTypeFromString (std::string typeStr)
 

Private Attributes

bool enabled
 
std::string systemName
 
std::string subsystemName
 
std::string nodeName
 
std::string componentName
 
DiscoveryType subsystemType
 
DiscoveryType nodeType
 
DiscoveryType componentType
 

Additional Inherited Members

- Public Types inherited from openjaus::core_v1_1::services::DiscoverySettingsInterface
enum  DiscoveryType {
  UNKNOWN = 0, VEHICLE = 10001, OCU = 20001, OTHER_SUBSYSTEM = 30001,
  NODE = 40001, PAYLOAD = 50001, COMPONENT = 60001
}
 

Detailed Description

Constructor & Destructor Documentation

◆ DiscoverySettings()

openjaus::core_v1_1::services::DiscoverySettings::DiscoverySettings ( )

◆ ~DiscoverySettings()

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

Member Function Documentation

◆ getComponentName()

std::string openjaus::core_v1_1::services::DiscoverySettings::getComponentName ( )
virtual

◆ getComponentType()

DiscoverySettingsInterface::DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::getComponentType ( )
virtual

◆ getNodeName()

std::string openjaus::core_v1_1::services::DiscoverySettings::getNodeName ( )
virtual

◆ getNodeType()

DiscoverySettingsInterface::DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::getNodeType ( )
virtual

◆ getSubsystemName()

std::string openjaus::core_v1_1::services::DiscoverySettings::getSubsystemName ( )
virtual

◆ getSubsystemType()

DiscoverySettingsInterface::DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::getSubsystemType ( )
virtual

◆ getSystemName()

std::string openjaus::core_v1_1::services::DiscoverySettings::getSystemName ( )
virtual

◆ getTypeFromString()

DiscoverySettingsInterface::DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::getTypeFromString ( std::string  typeStr)
staticprivate

◆ isEnabled()

bool openjaus::core_v1_1::services::DiscoverySettings::isEnabled ( )
virtual

◆ loadFromConfFile() [1/2]

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

◆ loadFromConfFile() [2/2]

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

◆ setComponentName()

void openjaus::core_v1_1::services::DiscoverySettings::setComponentName ( std::string  name)

◆ setComponentType()

void openjaus::core_v1_1::services::DiscoverySettings::setComponentType ( DiscoveryType  value)

◆ setEnabled()

void openjaus::core_v1_1::services::DiscoverySettings::setEnabled ( bool  value)

◆ setNodeName()

void openjaus::core_v1_1::services::DiscoverySettings::setNodeName ( std::string  name)

◆ setNodeType()

void openjaus::core_v1_1::services::DiscoverySettings::setNodeType ( DiscoveryType  value)

◆ setSubsystemName()

void openjaus::core_v1_1::services::DiscoverySettings::setSubsystemName ( std::string  name)

◆ setSubsystemType()

void openjaus::core_v1_1::services::DiscoverySettings::setSubsystemType ( DiscoveryType  value)

◆ setSystemName()

void openjaus::core_v1_1::services::DiscoverySettings::setSystemName ( std::string  name)

◆ verify()

void openjaus::core_v1_1::services::DiscoverySettings::verify ( )
private

Member Data Documentation

◆ componentName

std::string openjaus::core_v1_1::services::DiscoverySettings::componentName
private

◆ componentType

DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::componentType
private

◆ enabled

bool openjaus::core_v1_1::services::DiscoverySettings::enabled
private

◆ nodeName

std::string openjaus::core_v1_1::services::DiscoverySettings::nodeName
private

◆ nodeType

DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::nodeType
private

◆ subsystemName

std::string openjaus::core_v1_1::services::DiscoverySettings::subsystemName
private

◆ subsystemType

DiscoveryType openjaus::core_v1_1::services::DiscoverySettings::subsystemType
private

◆ systemName

std::string openjaus::core_v1_1::services::DiscoverySettings::systemName
private

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