OpenRTM-aist  1.2.1
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
RTC::ManagerConfig Class Reference

Manager configuration class. More...

#include <ManagerConfig.h>

Collaboration diagram for RTC::ManagerConfig:
Collaboration graph
[legend]

Public Member Functions

 ManagerConfig ()
 Constructor. More...
 
 ManagerConfig (int argc, char **argv)
 Constructor. More...
 
virtual ~ManagerConfig (void)
 Destructor. More...
 
void init (int argc, char **argv)
 Initialization. More...
 
void configure (coil::Properties &prop)
 Specify the configuration information to the Property. More...
 
coil::Properties getConfig () const
 Get the configuration. More...
 

Static Public Attributes

static const char * config_file_path []
 The default configuration file path for manager. More...
 
static const char * config_file_env
 The environment variable to distinguish the default configuration file path. More...
 

Protected Member Functions

void parseArgs (int argc, char **argv)
 Parse the command arguments. More...
 
bool findConfigFile ()
 Find the configuration file. More...
 
void setSystemInformation (coil::Properties &prop)
 Set system information. More...
 
bool fileExist (const std::string &filename)
 Check the file existence. More...
 

Protected Attributes

coil::Properties m_argprop
 configuration properties from arguments More...
 
std::string m_configFile
 Manager's configuration file path. More...
 
bool m_isMaster
 Manager master flag. More...
 

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:

Since
0.4.0

Constructor & Destructor Documentation

RTC::ManagerConfig::ManagerConfig ( )

Constructor.

Constructor (Do nothing)

RTC::ManagerConfig::ManagerConfig ( int  argc,
char **  argv 
)

Constructor.

Initialize configuration information by given arguments.

Parameters
argcNumber of command line arguments
argvThe command line arguments
virtual RTC::ManagerConfig::~ManagerConfig ( void  )
virtual

Destructor.

Member Function Documentation

void RTC::ManagerConfig::configure ( coil::Properties prop)

Specify the configuration information to the Property.

Configure to the properties specified by Manager's configuration

Parameters
propThe target properties to configure
bool RTC::ManagerConfig::fileExist ( const std::string &  filename)
protected

Check the file existence.

Confirm whether the specified file exists

Parameters
filenameThe target confirmation file
Returns
file existance confirmation (True if the file exists.)
bool RTC::ManagerConfig::findConfigFile ( )
protected

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
coil::Properties RTC::ManagerConfig::getConfig ( ) const

Get the configuration.

Get the configuration. When this operation is called before calling init() function, return the default configuration statically defined, When this operation is called after calling init() function, return the initialized configuration according to the command line arguments, the environment variables etc. (Not implemented)

Returns
Manager's configuration information
void RTC::ManagerConfig::init ( int  argc,
char **  argv 
)

Initialization.

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

  • -a : Disable manager service
  • -f <file name>=""> : Specify a configuration file
  • -o <option> ; Specify options
  • -p <port number>="">: Specify a port number
  • -d : Run as the master manager
Parameters
argcNumber of command line arguments
argvThe command line arguments
void RTC::ManagerConfig::parseArgs ( int  argc,
char **  argv 
)
protected

Parse the command arguments.

  • -a : Disable manager service
  • -f <file name>=""> : Specify a configuration file
  • -o <option> ; Specify options
  • -p <port number>="">: Specify a port number
  • -d : Run as the master manager
Parameters
argcNumber of command line arguments
argvThe command line arguments
void RTC::ManagerConfig::setSystemInformation ( coil::Properties prop)
protected

Set system information.

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

  • os.name : OS name
  • os.release : OS release name
  • os.version : OS version
  • os.arch : OS architecture
  • os.hostname: Hostname
  • manager.pid : process ID
Parameters
propProperties to set system information

Member Data Documentation

const char* RTC::ManagerConfig::config_file_env
static

The environment variable to distinguish the default configuration file path.

const char* RTC::ManagerConfig::config_file_path[]
static

The default configuration file path for manager.

coil::Properties RTC::ManagerConfig::m_argprop
protected

configuration properties from arguments

std::string RTC::ManagerConfig::m_configFile
protected

Manager's configuration file path.

bool RTC::ManagerConfig::m_isMaster
protected

Manager master flag.

true:master,false:slave


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