12#ifndef HPP_SERVICE_SERVICEPROPERTY_HPP_
13#define HPP_SERVICE_SERVICEPROPERTY_HPP_
21#include "osapi/osapi_type.h"
23#include "routingservice/routingservice_infrastructure.h"
24#include "routingservice/routingservice_service.h"
26#include <dds/core/SafeEnumeration.hpp>
27#include <rti/recording/PropertySet.hpp>
29namespace rti {
namespace recording {
57 XML_CONVERTER_APPLICATION,
68typedef dds::core::safe_enum<ApplicationRoleKind_def> ApplicationRoleKind;
73struct XmlConverterRoleKind_def {
82typedef dds::core::safe_enum<XmlConverterRoleKind_def> XmlConverterRoleKind;
88struct IndexerModeKind_def {
96typedef dds::core::safe_enum<IndexerModeKind_def> IndexerModeKind;
98typedef rti::routing::PropertySet PropertySet;
113 application_name_(
""),
115 enable_administration_(false),
116 administration_domain_id_(0),
117 enable_monitoring_(false),
118 monitoring_domain_id_(0),
119 application_role_(ApplicationRoleKind::RECORD_APPLICATION),
120 enforce_xsd_validation_(true),
121 ignore_default_files_(false),
122 output_cfg_file_(
""),
124 reverse_mode_(false),
125 xml_converter_role_(XmlConverterRoleKind::RECORD_CONVERT),
126 indexer_mode_(IndexerModeKind::INSTANCE_INDEXING),
158 return service_name_;
183 return application_name_;
213 return domain_id_base_;
221 return enforce_xsd_validation_;
232 enforce_xsd_validation_ = enforce;
247 domain_id_base_ = domain_id;
257 return enable_administration_;
278 return administration_domain_id_;
293 administration_domain_id_ = domain_id;
303 return enable_monitoring_;
323 return monitoring_domain_id_;
338 monitoring_domain_id_ = domain_id;
347 return application_role_;
366 return ignore_default_files_;
380 ignore_default_files_ = ignore;
389 return license_file_;
407 const std::string output_cfg_file()
const
409 return output_cfg_file_;
416 const std::string & output_cfg_file)
418 output_cfg_file_ = output_cfg_file;
448 return reverse_mode_;
467 XmlConverterRoleKind xml_converter_role()
const
469 return xml_converter_role_;
476 const XmlConverterRoleKind & xml_converter_role)
478 xml_converter_role_ = xml_converter_role;
486 IndexerModeKind indexer_mode()
const
488 return indexer_mode_;
497 indexer_mode_ = indexer_mode;
505 const std::string& db_directory()
const
507 return db_directory_;
516 db_directory_ = db_directory;
553 std::string cfg_file_;
555 std::string service_name_;
556 std::string application_name_;
557 int32_t domain_id_base_;
558 bool enable_administration_;
559 int32_t administration_domain_id_;
560 bool enable_monitoring_;
561 int32_t monitoring_domain_id_;
562 ApplicationRoleKind application_role_;
563 bool enforce_xsd_validation_;
564 bool ignore_default_files_;
565 std::string license_file_;
567 std::string output_cfg_file_;
570 XmlConverterRoleKind xml_converter_role_;
571 IndexerModeKind indexer_mode_;
572 std::string db_directory_;
573 PropertySet user_env_;
Configuration for a RTI Recording Service object.
Definition: ServiceProperty.hpp:105
ServiceProperty & enable_administration(bool enable_administration)
Set this to true to enable remote administration or false to disable it.
Definition: ServiceProperty.hpp:266
const std::string & cfg_file() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:136
ServiceProperty & cfg_file(const std::string &cfg_file)
Path to an RTI Recording Service configuration file.
Definition: ServiceProperty.hpp:146
int32_t administration_domain_id() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:276
int32_t domain_id_base() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:211
int32_t monitoring_domain_id() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:321
bool enable_monitoring() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:301
bool ignore_default_files() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:364
bool debug_mode() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:425
ServiceProperty & application_role(ApplicationRoleKind application_role)
Selects the operation mode of the service.
Definition: ServiceProperty.hpp:355
ServiceProperty & license_file(const std::string &license_file)
Path to an RTI Connext license file. This parameter is only used if your installation requires a lice...
Definition: ServiceProperty.hpp:398
ServiceProperty & service_name(const std::string &service_name)
The name of the RTI Recording Service configuration to run.
Definition: ServiceProperty.hpp:171
ServiceProperty & administration_domain_id(int32_t domain_id)
If ServiceProperty::enable_administration is true, this is the domain ID to use for remote administra...
Definition: ServiceProperty.hpp:291
ServiceProperty & reverse_mode(bool reverse_mode)
Set this to true to enable reverse mode or false to disable it.
Definition: ServiceProperty.hpp:457
ServiceProperty & enforce_xsd_validation(bool enforce)
Controls whether the service applies XSD validation to the loaded configuration.
Definition: ServiceProperty.hpp:230
bool reverse_mode() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:446
const std::string & service_name() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:156
ServiceProperty & enable_monitoring(bool enable_monitoring)
Set it to true to enable remote monitoring or false to disable it.
Definition: ServiceProperty.hpp:312
const std::string & license_file() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:387
ServiceProperty()
Creates a property object with default settings.
Definition: ServiceProperty.hpp:110
const ApplicationRoleKind & application_role() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:345
ServiceProperty & debug_mode(bool debug_mode)
Set this to true to enable debug mode or false to disable it.
Definition: ServiceProperty.hpp:436
bool enforce_xsd_validation() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:219
bool enable_administration() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:255
ServiceProperty & monitoring_domain_id(int32_t domain_id)
If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring.
Definition: ServiceProperty.hpp:336
ServiceProperty & ignore_default_files(bool ignore)
Set it to true to avoid loading the standard files usually loaded by RTI Recording Service.
Definition: ServiceProperty.hpp:378
PropertySet & user_environment()
Non-const getter for modification that can be used to add elements individually. (see setter with the...
Definition: ServiceProperty.hpp:532
const PropertySet & user_environment() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:523
const std::string & application_name() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:181
ServiceProperty & application_name(const std::string &application_name)
Assigns a name to the execution of the RTI Recording Service.
Definition: ServiceProperty.hpp:200
ServiceProperty & domain_id_base(int32_t domain_id)
Value that is added to the domain IDs of the domain routes in the XML configuration.
Definition: ServiceProperty.hpp:245
ServiceProperty & user_environment(const PropertySet &user_environment)
Dictionary of user variables. The dictionary provides a parallel way to expand XML configuration vari...
Definition: ServiceProperty.hpp:545
The RTI namespace.
Definition: RecordingServiceImpl.hpp:22
Definition: ServiceProperty.hpp:37
type
The underlying enum type.
Definition: ServiceProperty.hpp:41
@ RECORD_APPLICATION
Record mode.
Definition: ServiceProperty.hpp:45
@ CONVERTER_APPLICATION
Converter mode.
Definition: ServiceProperty.hpp:53
@ REPLAY_APPLICATION
Replay mode.
Definition: ServiceProperty.hpp:49