Public Member Functions | Static Public Attributes | Private Attributes | List of all members
OpenRTM_aist.ManagerConfig.ManagerConfig Class Reference

Manager configuration class. More...

Public Member Functions

def __init__ (self, argv=None)
 ManagerConfig constructor. More...
 
def configure (self, prop)
 Specify the configuration information to the Property. More...
 
def fileExist (self, filename)
 Check the file existence. More...
 
def findConfigFile (self)
 Find the configuration file. More...
 
def init (self, argv)
 Initialization. More...
 
def parseArgs (self, argv)
 Get configuration value. More...
 
def setSystemInformation (self, prop)
 Set system information. More...
 

Static Public Attributes

string config_file_env = "RTC_MANAGER_CONFIG"
 The environment variable to distinguish the default configuration file path. More...
 
list config_file_path
 The default configuration file path for manager. More...
 

Private Attributes

 _argprop
 
 _configFile
 
 _isMaster
 

Detailed Description

Manager configuration class.

Modify Manager's configuration. This class receives the command line arguments and will be instantiated. Set property information of Manager with the configuration file specified by the command line argument or the environment variable etc.

The priorities of each configuration are as follows:

  1. Command option "-f"
  2. Environment variable "RTC_MANAGER_CONFIG"
  3. Default configuration file "./rtc.conf"
  4. Default configuration file "/etc/rtc.conf"
  5. Default configuration file "/etc/rtc/rtc.conf"
  6. Default configuration file "/usr/local/etc/rtc.conf"
  7. Default configuration file "/usr/local/etc/rtc/rtc.conf"
  8. Embedded configuration value

If the command option "-d" is specified (even if specify configuration file by "-f" option), the embedded configuration values will be used.

Since
0.4.0

Definition at line 82 of file ManagerConfig.py.

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.ManagerConfig.ManagerConfig.__init__ (   self,
  argv = None 
)

ManagerConfig constructor.

The constructor that performs initialization at the same time with given arguments.

Parameters
argvThe command line arguments

Definition at line 131 of file ManagerConfig.py.

Member Function Documentation

◆ configure()

def OpenRTM_aist.ManagerConfig.ManagerConfig.configure (   self,
  prop 
)

Specify the configuration information to the Property.

Configure to the properties specified by Manager's configuration

Definition at line 188 of file ManagerConfig.py.

◆ fileExist()

def OpenRTM_aist.ManagerConfig.ManagerConfig.fileExist (   self,
  filename 
)

Check the file existence.

Confirm whether the specified file exists

Parameters
filenameThe target confirmation file
Returns
file existance confirmation (True if the file exists.)

Definition at line 415 of file ManagerConfig.py.

◆ findConfigFile()

def OpenRTM_aist.ManagerConfig.ManagerConfig.findConfigFile (   self)

Find the configuration file.

Find the configuration file and configure it. Confirm the file existence when the configuration file has already configured.

The priority of the configuration file
The command option¡äthe environment variable¡äthe default file¡ä the default configuration

Default force option(-d): Ignore any default files and use the default configuration.

Returns
Configuration file search result

Definition at line 326 of file ManagerConfig.py.

◆ init()

def OpenRTM_aist.ManagerConfig.ManagerConfig.init (   self,
  argv 
)

Initialization.

Initialize with command line options. The following command options are available.

-f file : Specify a configuration file.
-l module : Specify modules to be loaded at the beginning.
-o options: Other options.
-d : Use default static configuration.

Definition at line 169 of file ManagerConfig.py.

◆ parseArgs()

def OpenRTM_aist.ManagerConfig.ManagerConfig.parseArgs (   self,
  argv 
)

Get configuration value.

This operation returns default configuration statically defined, when before calling init() function. When after calling init() function, this operation returns initialized configuration value according to command option, environment value and so on.

def getConfig(self): pass

Parse command arguments

-f file : Specify a configuration file.
-l module : Specify modules to be loaded at the beginning.
-o options: Other options.
-d : Use default static configuration.

Definition at line 254 of file ManagerConfig.py.

◆ setSystemInformation()

def OpenRTM_aist.ManagerConfig.ManagerConfig.setSystemInformation (   self,
  prop 
)

Set system information.

Get the following system info and set them to Manager's properties.

  • manager.os.name : OS name
  • manager.os.release : OS release name
  • manager.os.version : OS version
  • manager.os.arch : OS architecture
  • manager.os.hostname: Hostname
  • manager.pid : process ID

Definition at line 378 of file ManagerConfig.py.

Member Data Documentation

◆ _argprop

OpenRTM_aist.ManagerConfig.ManagerConfig._argprop
private

Definition at line 134 of file ManagerConfig.py.

◆ _configFile

OpenRTM_aist.ManagerConfig.ManagerConfig._configFile
private

Definition at line 133 of file ManagerConfig.py.

◆ _isMaster

OpenRTM_aist.ManagerConfig.ManagerConfig._isMaster
private

Definition at line 135 of file ManagerConfig.py.

◆ config_file_env

string OpenRTM_aist.ManagerConfig.ManagerConfig.config_file_env = "RTC_MANAGER_CONFIG"
static

The environment variable to distinguish the default configuration file path.

Definition at line 108 of file ManagerConfig.py.

◆ config_file_path

list OpenRTM_aist.ManagerConfig.ManagerConfig.config_file_path
static
Initial value:
= ["./rtc.conf",
"/etc/rtc.conf",
"/etc/rtc/rtc.conf",
"/usr/local/etc/rtc.conf",
"/usr/local/etc/rtc/rtc.conf",
None]

The default configuration file path for manager.

Definition at line 92 of file ManagerConfig.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:08