comms.config.Configuration Class Reference

This class provides default configuration values for the rtctkConfigTool tool itself. More...

Public Member Functions
def	__init__ (self)
def	set_config_param_names (self, config_param_names)
def	log_config (self)
	Logs the current configuration values in a single log message. More...
def	load_config (self, Optional[Uri] cli_config_uri, Optional[Uri] cli_service_discovery_endpoint, Optional[str] cli_log_level, Optional[Uri] cli_runtime_repo_endpoint, Optional[Uri] cli_persistent_repo_endpoint, Optional[bool] cli_console_quiet)
def	convert_to_log_level (self, level)

Static Public Member Functions
def	init_logger_config (file_name_base, console_quiet=False)

Public Attributes
	console_quiet
	config_endpoint_location
	service_discovery_endpoint_location
	log_level
	log_level_location
	runtime_repo_endpoint_location
	persistent_repo_endpoint_location

Static Public Attributes
	config_uri = Uri('file:persistent_repo')
string	config_location = 'Default'
	service_discovery_endpoint_path = DataPointPath('/rtctk_config_tool/service_discovery_endpoint')
	service_discovery_endpoint = Uri('file:service_disc.yaml')
string	service_discovery_endpoint_location = 'Default'
	log_level_path = DataPointPath('/rtctk_config_tool/log_level')
string	log_level = "INFO"
string	log_level_location = 'Default'
list	valid_log_levels = ['CRITICAL', 'FATAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'TRACE', 'NOTSET']
	runtime_repo_endpoint_path = DataPointPath('/rtctk_config_tool/runtime_repo_endpoint')
	runtime_repo_endpoint = Uri('file:runtime_repo')
string	runtime_repo_endpoint_location = 'Default'
	persistent_repo_endpoint_path = DataPointPath('/rtctk_config_tool/persistent_repo_endpoint')
	persistent_repo_endpoint = Uri('file:persistent_repo')
string	persistent_repo_endpoint_location = 'Default'
bool	console_quiet = False
	console_quiet_path = DataPointPath('/rtctk_config_tool/console_quiet')
string	console_quiet_location = 'Default'

Detailed Description

This class provides default configuration values for the rtctkConfigTool tool itself.

Only the configuration parameters needed to make the tool work are maintained in this class. This includes their default values, the corresponding environment variable and datapoint paths when loading from file or the central configuration system. These parameters should not be confused with the RTC system configuration.

Some additional helper methods are also provided to deal with various aspects of configuring the tool.

Constructor & Destructor Documentation

__init__()

def comms.config.Configuration.__init__

(

self

)

Member Function Documentation

convert_to_log_level()

def comms.config.Configuration.convert_to_log_level	(		self,
			level
	)

init_logger_config()

def comms.config.Configuration.init_logger_config (   file_name_base,   console_quiet = False  )

static

load_config()

def comms.config.Configuration.load_config	(		self,
		Optional[Uri]	cli_config_uri,
		Optional[Uri]	cli_service_discovery_endpoint,
		Optional[str]	cli_log_level,
		Optional[Uri]	cli_runtime_repo_endpoint,
		Optional[Uri]	cli_persistent_repo_endpoint,
		Optional[bool]	cli_console_quiet
	)

log_config()

def comms.config.Configuration.log_config

(

self

)

Logs the current configuration values in a single log message.

set_config_param_names()

def comms.config.Configuration.set_config_param_names	(		self,
			config_param_names
	)

Member Data Documentation

config_endpoint_location

comms.config.Configuration.config_endpoint_location

config_location

string comms.config.Configuration.config_location = 'Default'

static

config_uri

comms.config.Configuration.config_uri = Uri('file:persistent_repo')

static

console_quiet [1/2]

bool comms.config.Configuration.console_quiet = False

static

console_quiet [2/2]

comms.config.Configuration.console_quiet

console_quiet_location

string comms.config.Configuration.console_quiet_location = 'Default'

static

console_quiet_path

comms.config.Configuration.console_quiet_path = DataPointPath('/rtctk_config_tool/console_quiet')

static

log_level [1/2]

string comms.config.Configuration.log_level = "INFO"

static

log_level [2/2]

comms.config.Configuration.log_level

log_level_location [1/2]

string comms.config.Configuration.log_level_location = 'Default'

static

log_level_location [2/2]

comms.config.Configuration.log_level_location

log_level_path

comms.config.Configuration.log_level_path = DataPointPath('/rtctk_config_tool/log_level')

static

persistent_repo_endpoint

comms.config.Configuration.persistent_repo_endpoint = Uri('file:persistent_repo')

static

persistent_repo_endpoint_location [1/2]

string comms.config.Configuration.persistent_repo_endpoint_location = 'Default'

static

persistent_repo_endpoint_location [2/2]

comms.config.Configuration.persistent_repo_endpoint_location

persistent_repo_endpoint_path

comms.config.Configuration.persistent_repo_endpoint_path = DataPointPath('/rtctk_config_tool/persistent_repo_endpoint')

static

runtime_repo_endpoint

comms.config.Configuration.runtime_repo_endpoint = Uri('file:runtime_repo')

static

runtime_repo_endpoint_location [1/2]

string comms.config.Configuration.runtime_repo_endpoint_location = 'Default'

static

runtime_repo_endpoint_location [2/2]

comms.config.Configuration.runtime_repo_endpoint_location

runtime_repo_endpoint_path

comms.config.Configuration.runtime_repo_endpoint_path = DataPointPath('/rtctk_config_tool/runtime_repo_endpoint')

static

service_discovery_endpoint

comms.config.Configuration.service_discovery_endpoint = Uri('file:service_disc.yaml')

static

service_discovery_endpoint_location [1/2]

string comms.config.Configuration.service_discovery_endpoint_location = 'Default'

static

service_discovery_endpoint_location [2/2]

comms.config.Configuration.service_discovery_endpoint_location

service_discovery_endpoint_path

comms.config.Configuration.service_discovery_endpoint_path = DataPointPath('/rtctk_config_tool/service_discovery_endpoint')

static

valid_log_levels

list comms.config.Configuration.valid_log_levels = ['CRITICAL', 'FATAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'TRACE', 'NOTSET']

static

---

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

• reusableComponents/configTool/src/rtctk/configtool/comms/config.py