RTI Routing Service  Version 6.0.1
 All Data Structures Files Functions Typedefs Enumerations Enumerator Groups Pages
rti::routing::ServiceProperty Class Reference

Configuration for a RTI Routing Service object. More...

#include <ServiceProperty.hpp>

Inherits NativeValueType< ServiceProperty >.

Public Member Functions

 ServiceProperty ()
 Creates a property object with default settings.
 
std::string cfg_file () const
 Getter (see setter with the same name)
 
ServicePropertycfg_file (const std::string &filename)
 Path to an RTI Routing Service configuration file.
 
const std::vector< std::string > & cfg_strings () const
 Getter (see setter with the same name)
 
ServicePropertycfg_strings (const std::vector< std::string > &the_cfg_strings)
 XML configuration represented as strings.
 
std::string service_name () const
 Getter (see setter with the same name)
 
ServicePropertyservice_name (const std::string &name)
 The name of the RTI Routing Service configuration to run.
 
std::string application_name () const
 Getter (see setter with the same name)
 
ServicePropertyapplication_name (const std::string &name)
 Assigns a name to the execution of the RTI Routing Service.
 
bool enforce_xsd_validation () const
 Getter (see setter with the same name)
 
ServicePropertyenforce_xsd_validation (const bool enforce_xsd_validation)
 Controls whether the service applies XSD validation to the loaded configuration.
 
int domain_id_base () const
 Getter (see setter with the same name)
 
ServicePropertydomain_id_base (const int domain_id)
 Value that is added to the domain IDs of the domain routes in the XML configuration.
 
std::string plugin_search_path () const
 Getter (see setter with the same name)
 
ServicePropertyplugin_search_path (const std::string &path)
 This path is used to look for plugin libraries.
 
bool dont_start_service () const
 Getter (see setter with the same name)
 
ServicePropertydont_start_service (const bool not_start)
 Set this to true to if you do not want RTI Routing Service enabled when RoutingServcie::start is called.
 
bool enable_administration () const
 Getter (see setter with the same name)
 
ServicePropertyenable_administration (const bool enable)
 Set this to true to enable remote administration or false to disable it.
 
int administration_domain_id () const
 Getter (see setter with the same name)
 
ServicePropertyadministration_domain_id (const int domain_id)
 If ServiceProperty::enable_administration is true, this is the domain ID to use for remote administration.
 
bool enable_monitoring () const
 Getter (see setter with the same name)
 
ServicePropertyenable_monitoring (const bool &enable)
 Set it to true to enable remote monitoring or false to disable it.
 
int monitoring_domain_id () const
 Getter (see setter with the same name)
 
ServicePropertymonitoring_domain_id (const int &domain_id)
 If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring.
 
bool skip_default_files () const
 Getter (see setter with the same name)
 
ServicePropertyskip_default_files (const bool &skip)
 Set it to true to avoid loading the standard files usually loaded by RTI Routing Service.
 
bool identify_execution () const
 Getter (see setter with the same name)
 
ServicePropertyidentify_execution (const bool &identify)
 Set this to true to append the host name and process ID to the RTI Routing Service execution name.
 
std::string license_file_name () const
 Getter (see setter with the same name)
 
ServicePropertylicense_file_name (const std::string &filename)
 Path to an RTI Routing Service license file.
 
std::map< std::string,
std::string > 
user_environment () const
 Getter (see setter with the same name)
 
ServicePropertyuser_environment (const std::map< std::string, std::string > &user_environment)
 Dictionary of user variables. The dictionary provides a parallel way to expand XML configuration variables in the form , when they are not defined in the environment.
 

Detailed Description

Configuration for a RTI Routing Service object.

Constructor & Destructor Documentation

rti::routing::ServiceProperty::ServiceProperty ( )
inline

Creates a property object with default settings.

Member Function Documentation

std::string rti::routing::ServiceProperty::cfg_file ( ) const
inline

Getter (see setter with the same name)

Referenced by cfg_file().

ServiceProperty& rti::routing::ServiceProperty::cfg_file ( const std::string &  filename)
inline

Path to an RTI Routing Service configuration file.

[default] empty string.

References cfg_file().

const std::vector<std::string>& rti::routing::ServiceProperty::cfg_strings ( ) const
inline

Getter (see setter with the same name)

Referenced by cfg_strings().

ServiceProperty& rti::routing::ServiceProperty::cfg_strings ( const std::vector< std::string > &  the_cfg_strings)
inline

XML configuration represented as strings.

An array of strings that altogether make up an XML document to configure RTI Routing Service. This parameter is used only if ServiceProperty::cfg_file is empty.

The reason for using an array instead of one single string is to get around the limited size of literal strings. In general, if you create the XML string dynamically the vector needs only one element.

[default] empty.

References cfg_strings().

std::string rti::routing::ServiceProperty::service_name ( ) const
inline

Getter (see setter with the same name)

Referenced by service_name().

ServiceProperty& rti::routing::ServiceProperty::service_name ( const std::string &  name)
inline

The name of the RTI Routing Service configuration to run.

This is the name used to find the <routing_service> XML tag in the configuration file; the name that will be used to refer to this execution in remote administration and monitoring.

[default] empty string.

References service_name().

std::string rti::routing::ServiceProperty::application_name ( ) const
inline

Getter (see setter with the same name)

Referenced by application_name().

ServiceProperty& rti::routing::ServiceProperty::application_name ( const std::string &  name)
inline

Assigns a name to the execution of the RTI Routing Service.

Remote commands and status information will refer to the service using this name.

In addition, the name of DomainParticipants created by RTI Routing Service will be based on this name.

[default] empty string. If no application name is specified, RTI Routing Service will use ServiceProperty::service_name.

References application_name().

bool rti::routing::ServiceProperty::enforce_xsd_validation ( ) const
inline

Getter (see setter with the same name)

Referenced by enforce_xsd_validation().

ServiceProperty& rti::routing::ServiceProperty::enforce_xsd_validation ( const bool  enforce_xsd_validation)
inline

Controls whether the service applies XSD validation to the loaded configuration.

[default] true

References enforce_xsd_validation().

int rti::routing::ServiceProperty::domain_id_base ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::domain_id_base ( const int  domain_id)
inline

Value that is added to the domain IDs of the domain routes in the XML configuration.

By using this, an XML file can use relative domain IDs.

[default] 0

std::string rti::routing::ServiceProperty::plugin_search_path ( ) const
inline

Getter (see setter with the same name)

Referenced by plugin_search_path().

ServiceProperty& rti::routing::ServiceProperty::plugin_search_path ( const std::string &  path)
inline

This path is used to look for plugin libraries.

If the plugin class libraries specified in the XML file don't contain a full path, RTI Routing Service looks for them in this directory if not NULL.

[default] "." (working directory)

References plugin_search_path().

bool rti::routing::ServiceProperty::dont_start_service ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::dont_start_service ( const bool  not_start)
inline

Set this to true to if you do not want RTI Routing Service enabled when RoutingServcie::start is called.

RTI Routing Service can be enabled afterwards through remote administration.

[default] false

bool rti::routing::ServiceProperty::enable_administration ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::enable_administration ( const bool  enable)
inline

Set this to true to enable remote administration or false to disable it.

[default] false

int rti::routing::ServiceProperty::administration_domain_id ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::administration_domain_id ( const int  domain_id)
inline

If ServiceProperty::enable_administration is true, this is the domain ID to use for remote administration.

Takes precedence over the XML configuration. If ServiceProperty::enable_administration is false, this value is not used even if remote administration is enabled in the XML configuration.

[default] 0

bool rti::routing::ServiceProperty::enable_monitoring ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::enable_monitoring ( const bool &  enable)
inline

Set it to true to enable remote monitoring or false to disable it.

[default] false

int rti::routing::ServiceProperty::monitoring_domain_id ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::monitoring_domain_id ( const int &  domain_id)
inline

If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring.

Takes precedence over the XML configuration. If ServiceProperty::enable_monitoring is false, this value is not used, even if remote monitoring is enabled in the XML configuration.

[default] 0

bool rti::routing::ServiceProperty::skip_default_files ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::skip_default_files ( const bool &  skip)
inline

Set it to true to avoid loading the standard files usually loaded by RTI Routing Service.

Only the configuration in ServiceProperty::cfg_file or ServiceProperty::cfg_strings will be loaded.

[default] false

bool rti::routing::ServiceProperty::identify_execution ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::identify_execution ( const bool &  identify)
inline

Set this to true to append the host name and process ID to the RTI Routing Service execution name.

Used to get unique names for remote administration and monitoring.

[default] false

std::string rti::routing::ServiceProperty::license_file_name ( ) const
inline

Getter (see setter with the same name)

Referenced by license_file_name().

ServiceProperty& rti::routing::ServiceProperty::license_file_name ( const std::string &  filename)
inline

Path to an RTI Routing Service license file.

If not empty, this file is checked for a valid license; otherwise, default location will be used. This parameter is not used in unlicensed versions.

[default] empty string.

References license_file_name().

std::map<std::string, std::string> rti::routing::ServiceProperty::user_environment ( ) const
inline

Getter (see setter with the same name)

ServiceProperty& rti::routing::ServiceProperty::user_environment ( const std::map< std::string, std::string > &  user_environment)
inline

Dictionary of user variables. The dictionary provides a parallel way to expand XML configuration variables in the form , when they are not defined in the environment.

[default] empty


RTI Routing Service Version 6.0.1 Copyright © Sun Nov 17 2019 Real-Time Innovations, Inc