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> 29 namespace rti {
namespace recording {
57 XML_CONVERTER_APPLICATION,
68 typedef dds::core::safe_enum<ApplicationRoleKind_def> ApplicationRoleKind;
73 struct XmlConverterRoleKind_def {
82 typedef dds::core::safe_enum<XmlConverterRoleKind_def> XmlConverterRoleKind;
88 struct IndexerModeKind_def {
96 typedef dds::core::safe_enum<IndexerModeKind_def> IndexerModeKind;
98 typedef 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),
120 enforce_xsd_validation_(true),
121 ignore_default_files_(false),
122 output_cfg_file_(
""),
124 xml_converter_role_(XmlConverterRoleKind::RECORD_CONVERT),
125 indexer_mode_(IndexerModeKind::INSTANCE_INDEXING)
146 cfg_file_ = cfg_file;
156 return service_name_;
171 service_name_ = service_name;
181 return application_name_;
200 application_name_ = application_name;
211 return domain_id_base_;
219 return enforce_xsd_validation_;
230 enforce_xsd_validation_ = enforce;
245 domain_id_base_ = domain_id;
255 return enable_administration_;
266 enable_administration_ = enable_administration;
276 return administration_domain_id_;
291 administration_domain_id_ = domain_id;
301 return enable_monitoring_;
312 enable_monitoring_ = enable_monitoring;
321 return monitoring_domain_id_;
336 monitoring_domain_id_ = domain_id;
345 return application_role_;
355 application_role_ = application_role;
364 return ignore_default_files_;
378 ignore_default_files_ = ignore;
387 return license_file_;
398 license_file_ = license_file;
405 const std::string output_cfg_file()
const 407 return output_cfg_file_;
414 const std::string & output_cfg_file)
416 output_cfg_file_ = output_cfg_file;
436 debug_mode_ = debug_mode;
444 XmlConverterRoleKind xml_converter_role()
const 446 return xml_converter_role_;
453 const XmlConverterRoleKind & xml_converter_role)
455 xml_converter_role_ = xml_converter_role;
463 IndexerModeKind indexer_mode()
const 465 return indexer_mode_;
474 indexer_mode_ = indexer_mode;
482 const std::string& db_directory()
const 484 return db_directory_;
493 db_directory_ = db_directory;
524 user_env_ = user_environment;
530 std::string cfg_file_;
532 std::string service_name_;
533 std::string application_name_;
534 int32_t domain_id_base_;
535 bool enable_administration_;
536 int32_t administration_domain_id_;
537 bool enable_monitoring_;
538 int32_t monitoring_domain_id_;
539 ApplicationRoleKind application_role_;
540 bool enforce_xsd_validation_;
541 bool ignore_default_files_;
542 std::string license_file_;
544 std::string output_cfg_file_;
546 XmlConverterRoleKind xml_converter_role_;
547 IndexerModeKind indexer_mode_;
548 std::string db_directory_;
549 PropertySet user_env_;
const ApplicationRoleKind & application_role() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:343
int32_t administration_domain_id() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:274
PropertySet & user_environment()
Non-const getter for modification that can be used to add elements individually. (see setter with the...
Definition: ServiceProperty.hpp:509
ServiceProperty & enforce_xsd_validation(bool enforce)
Controls whether the service applies XSD validation to the loaded configuration.
Definition: ServiceProperty.hpp:228
int32_t monitoring_domain_id() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:319
ServiceProperty & enable_administration(bool enable_administration)
Set this to true to enable remote administration or false to disable it.
Definition: ServiceProperty.hpp:264
const PropertySet & user_environment() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:500
ServiceProperty & debug_mode(bool debug_mode)
Set this to true to enable debug mode or false to disable it.
Definition: ServiceProperty.hpp:434
Converter mode.
Definition: ServiceProperty.hpp:53
int32_t domain_id_base() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:209
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:376
ServiceProperty & application_name(const std::string &application_name)
Assigns a name to the execution of the RTI Recording Service.
Definition: ServiceProperty.hpp:198
type
The underlying enum type.
Definition: ServiceProperty.hpp:41
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:334
Configuration for a RTI Recording Service object.
Definition: ServiceProperty.hpp:105
const std::string & application_name() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:179
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:522
bool ignore_default_files() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:362
const std::string & service_name() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:154
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:289
Record mode.
Definition: ServiceProperty.hpp:45
Replay mode.
Definition: ServiceProperty.hpp:49
Definition: ServiceProperty.hpp:37
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...
Definition: ServiceProperty.hpp:396
const std::string & license_file() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:385
bool enable_monitoring() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:299
The RTI namespace.
Definition: RecordingServiceImpl.hpp:22
ServiceProperty & enable_monitoring(bool enable_monitoring)
Set it to true to enable remote monitoring or false to disable it.
Definition: ServiceProperty.hpp:310
const std::string & cfg_file() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:134
ServiceProperty & cfg_file(const std::string &cfg_file)
Path to an RTI Recording Service configuration file.
Definition: ServiceProperty.hpp:144
ServiceProperty()
Creates a property object with default settings.
Definition: ServiceProperty.hpp:110
bool enforce_xsd_validation() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:217
bool enable_administration() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:253
ServiceProperty & service_name(const std::string &service_name)
The name of the RTI Recording Service configuration to run.
Definition: ServiceProperty.hpp:169
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:243
ServiceProperty & application_role(ApplicationRoleKind application_role)
Selects the operation mode of the service.
Definition: ServiceProperty.hpp:353
bool debug_mode() const
Getter (see setter with the same name)
Definition: ServiceProperty.hpp:423