rti::recording::ServiceProperty Class Reference

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

#include <ServiceProperty.hpp>

Public Member Functions
	ServiceProperty ()
	Creates a property object with default settings.
const std::string &	cfg_file () const
	Getter (see setter with the same name)
ServiceProperty &	cfg_file (const std::string &cfg_file)
	Path to an RTI Recording Service configuration file.
const std::string &	service_name () const
	Getter (see setter with the same name)
ServiceProperty &	service_name (const std::string &service_name)
	The name of the RTI Recording Service configuration to run.
const std::string &	application_name () const
	Getter (see setter with the same name)
ServiceProperty &	application_name (const std::string &application_name)
	Assigns a name to the execution of the RTI Recording Service.
int32_t	domain_id_base () const
	Getter (see setter with the same name)
bool	enforce_xsd_validation () const
	Getter (see setter with the same name)
ServiceProperty &	enforce_xsd_validation (bool enforce)
	Controls whether the service applies XSD validation to the loaded configuration.
ServiceProperty &	domain_id_base (int32_t domain_id)
	Value that is added to the domain IDs of the domain routes in the XML configuration.
bool	enable_administration () const
	Getter (see setter with the same name)
ServiceProperty &	enable_administration (bool enable_administration)
	Set this to true to enable remote administration or false to disable it.
int32_t	administration_domain_id () const
	Getter (see setter with the same name)
ServiceProperty &	administration_domain_id (int32_t 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)
ServiceProperty &	enable_monitoring (bool enable_monitoring)
	Set it to true to enable remote monitoring or false to disable it.
int32_t	monitoring_domain_id () const
	Getter (see setter with the same name)
ServiceProperty &	monitoring_domain_id (int32_t domain_id)
	If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring.
const ApplicationRoleKind &	application_role () const
	Getter (see setter with the same name)
ServiceProperty &	application_role (ApplicationRoleKind application_role)
	Selects the operation mode of the service.
bool	ignore_default_files () const
	Getter (see setter with the same name)
ServiceProperty &	ignore_default_files (bool ignore)
	Set it to true to avoid loading the standard files usually loaded by RTI Recording Service.
const std::string &	license_file () const
	Getter (see setter with the same name)
ServiceProperty &	license_file (const std::string &license_file)
	Path to an RTI Connext license file. This field is only used by license-managed versions of the tool.
const std::map< std::string, std::string > &	user_environment () const
	Getter (see setter with the same name)
std::map< std::string, std::string > &	user_environment ()
	Non-const getter for modification that can be used to add elements individually. (see setter with the same name)
ServiceProperty &	user_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 Recording Service object.

Constructor & Destructor Documentation

rti::recording::ServiceProperty::ServiceProperty ( )

inline

Creates a property object with default settings.

Member Function Documentation

const std::string& rti::recording::ServiceProperty::cfg_file ( ) const

inline

Getter (see setter with the same name)

Referenced by cfg_file().

ServiceProperty& rti::recording::ServiceProperty::cfg_file ( const std::string &  cfg_file )

inline

Path to an RTI Recording Service configuration file.

[default] empty string.

References cfg_file().

const std::string& rti::recording::ServiceProperty::service_name ( ) const

inline

Getter (see setter with the same name)

Referenced by service_name().

ServiceProperty& rti::recording::ServiceProperty::service_name ( const std::string &  service_name )

inline

The name of the RTI Recording Service configuration to run.

This is the name used to find the 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().

const std::string& rti::recording::ServiceProperty::application_name ( ) const

inline

Getter (see setter with the same name)

Referenced by application_name().

ServiceProperty& rti::recording::ServiceProperty::application_name ( const std::string &  application_name )

inline

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

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

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

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

References application_name().

int32_t rti::recording::ServiceProperty::domain_id_base ( ) const

inline

Getter (see setter with the same name)

bool rti::recording::ServiceProperty::enforce_xsd_validation ( ) const

inline

Getter (see setter with the same name)

ServiceProperty& rti::recording::ServiceProperty::enforce_xsd_validation ( bool  enforce )

inline

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

[default] true

ServiceProperty& rti::recording::ServiceProperty::domain_id_base ( int32_t  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

bool rti::recording::ServiceProperty::enable_administration ( ) const

inline

Getter (see setter with the same name)

Referenced by enable_administration().

ServiceProperty& rti::recording::ServiceProperty::enable_administration ( bool  enable_administration )

inline

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

[default] false

References enable_administration().

int32_t rti::recording::ServiceProperty::administration_domain_id ( ) const

inline

Getter (see setter with the same name)

ServiceProperty& rti::recording::ServiceProperty::administration_domain_id ( int32_t  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::recording::ServiceProperty::enable_monitoring ( ) const

inline

Getter (see setter with the same name)

Referenced by enable_monitoring().

ServiceProperty& rti::recording::ServiceProperty::enable_monitoring ( bool  enable_monitoring )

inline

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

[default] false

References enable_monitoring().

int32_t rti::recording::ServiceProperty::monitoring_domain_id ( ) const

inline

Getter (see setter with the same name)

ServiceProperty& rti::recording::ServiceProperty::monitoring_domain_id ( int32_t  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

const ApplicationRoleKind& rti::recording::ServiceProperty::application_role ( ) const

inline

Getter (see setter with the same name)

Referenced by application_role().

ServiceProperty& rti::recording::ServiceProperty::application_role ( ApplicationRoleKind  application_role )

inline

Selects the operation mode of the service.

See Also

ApplicationRoleKind

References application_role().

bool rti::recording::ServiceProperty::ignore_default_files ( ) const

inline

Getter (see setter with the same name)

ServiceProperty& rti::recording::ServiceProperty::ignore_default_files ( bool  ignore )

inline

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

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

[default] false

const std::string& rti::recording::ServiceProperty::license_file ( ) const

inline

Getter (see setter with the same name)

Referenced by license_file().

ServiceProperty& rti::recording::ServiceProperty::license_file ( const std::string &  license_file )

inline

Path to an RTI Connext license file. This field is only used by license-managed versions of the tool.

[default] empty string.

References license_file().

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

inline

Getter (see setter with the same name)

Referenced by user_environment().

std::map<std::string, std::string>& rti::recording::ServiceProperty::user_environment ( )

inline

Non-const getter for modification that can be used to add elements individually. (see setter with the same name)

ServiceProperty& rti::recording::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

References user_environment().