#include <managed_domain.h>
Public Member Functions | |
void | get_default_datawriter_qos (DataWriterQos^ qos) |
<<eXtension>> Copy the default DDS::DataWriterQos values into the provided DDS::DataWriterQos instance. | |
void | set_default_datawriter_qos (DataWriterQos^ qos) |
<<eXtension>> Set the default DataWriterQos values for this DomainParticipant. | |
void | set_default_datawriter_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Set the default DDS::DataWriterQos values for this domain participant based on the input XML QoS profile. | |
void | get_default_datareader_qos (DataReaderQos^ qos) |
<<eXtension>> Copy the default DDS::DataReaderQos values into the provided DDS::DataReaderQos instance. | |
void | set_default_datareader_qos (DataReaderQos^ qos) |
<<eXtension>> Set the default DDS::DataReaderQos values for this domain participant. | |
void | set_default_datareader_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Set the default DDS::DataReaderQos values for this DomainParticipant based on the input XML QoS profile. | |
void | get_default_flowcontroller_property (FlowControllerProperty_t^ prop) |
<<eXtension>> Copies the default DDS::FlowControllerProperty_t values for this domain participant into the given DDS::FlowControllerProperty_t instance. | |
void | set_default_flowcontroller_property (FlowControllerProperty_t^ prop) |
<<eXtension>> Set the default DDS::FlowControllerProperty_t values for this domain participant. | |
void | register_contentfilter (System::String^ filter_name, ContentFilter^ contentfilter) |
<<eXtension>> Register a content filter which can be used to create a DDS::ContentFilteredTopic. | |
ContentFilter^ | lookup_contentfilter (System::String^ filter_name) |
<<eXtension>> Lookup a content filter previously registered with DDS::DomainParticipant::register_contentfilter. | |
void | unregister_contentfilter (System::String^ filter_name) |
<<eXtension>> Unregister a content filter previously registered with DDS::DomainParticipant::register_contentfilter. | |
System::String^ | get_default_library () |
<<eXtension>> Gets the default XML library associated with a DDS::DomainParticipant. | |
System::String^ | get_default_profile () |
<<eXtension>> Gets the default XML profile associated with a DDS::DomainParticipant. | |
System::String^ | get_default_profile_library () |
<<eXtension>> Gets the library where the default XML QoS profile is contained for a DDS::DomainParticipant. | |
void | set_default_library (System::String^ library_name) |
<<eXtension>> Sets the default XML library for a DDS::DomainParticipant. | |
void | set_default_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Sets the default XML profile for a DDS::DomainParticipant. | |
Publisher^ | get_implicit_publisher () |
<<eXtension>> Returns the implicit DDS::Publisher. If an implicit Publisher does not already exist, this creates one. | |
Subscriber^ | get_implicit_subscriber () |
<<eXtension>> Returns the implicit DDS::Subscriber. If an implicit Subscriber does not already exist, this creates one. | |
DataWriter^ | create_datawriter (Topic^ topic, DataWriterQos^ qos, DataWriterListener^ listener, StatusMask mask) |
<<eXtension>> Creates a DDS::DataWriter that will be attached and belong to the implicit DDS::Publisher. | |
DataWriter^ | create_datawriter_with_profile (Topic^ topic, System::String^ library_name, System::String^ profile_name, DataWriterListener^ listener, StatusMask mask) |
<<eXtension>> Creates a DDS::DataWriter using a XML QoS profile that will be attached and belong to the implicit DDS::Publisher. | |
void | delete_datawriter (DataWriter^ %a_datawriter) |
<<eXtension>> Deletes a DDS::DataWriter that belongs to the implicit DDS::Publisher. | |
DataReader^ | create_datareader (ITopicDescription^ topic, DataReaderQos^ qos, DataReaderListener^ listener, StatusMask mask) |
<<eXtension>> Creates a DDS::DataReader that will be attached and belong to the implicit DDS::Subscriber. | |
DataReader^ | create_datareader_with_profile (ITopicDescription^ topic, System::String^ library_name, System::String^ profile_name, DataReaderListener^ listener, StatusMask mask) |
<<eXtension>> Creates a DDS::DataReader using a XML QoS profile that will be attached and belong to the implicit DDS::Subscriber. | |
void | delete_datareader (DataReader^ %a_datareader) |
<<eXtension>> Deletes a DDS::DataReader that belongs to the implicit DDS::Subscriber. | |
void | get_default_topic_qos (TopicQos^ qos) |
Copies the default DDS::TopicQos values for this domain participant into the given DDS::TopicQos instance. | |
void | set_default_topic_qos (TopicQos^ qos) |
Set the default DDS::TopicQos values for this domain participant. | |
void | set_default_topic_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Set the default DDS::TopicQos values for this domain participant based on the input XML QoS profile. | |
void | get_default_publisher_qos (PublisherQos^ qos) |
Copy the default DDS::PublisherQos values into the provided DDS::PublisherQos instance. | |
void | set_default_publisher_qos (PublisherQos^ qos) |
Set the default DDS::PublisherQos values for this DomainParticipant. | |
void | set_default_publisher_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Set the default DDS::PublisherQos values for this DomainParticipant based on the input XML QoS profile. | |
void | get_default_subscriber_qos (SubscriberQos^ qos) |
Copy the default DDS::SubscriberQos values into the provided DDS::SubscriberQos instance. | |
void | set_default_subscriber_qos (SubscriberQos^ qos) |
Set the default DDS::SubscriberQos values for this Domain{articipant. | |
void | set_default_subscriber_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Set the default DDS::SubscriberQos values for this DomainParticipant based on the input XML QoS profile. | |
Publisher^ | create_publisher (PublisherQos^ qos, PublisherListener^ listener, StatusMask mask) |
Creates a DDS::Publisher with the desired QoS policies and attaches to it the specified DDS::PublisherListener. | |
Publisher^ | create_publisher_with_profile (System::String^ library_name, System::String^ profile_name, PublisherListener^ listener, StatusMask mask) |
<<eXtension>> Creates a new DDS::Publisher object using the DDS::PublisherQos associated with the input XML QoS profile. | |
void | delete_publisher (Publisher^ %p) |
Deletes an existing DDS::Publisher. | |
Subscriber^ | create_subscriber (SubscriberQos^ qos, SubscriberListener^ listener, StatusMask mask) |
Creates a DDS::Subscriber with the desired QoS policies and attaches to it the specified DDS::SubscriberListener. | |
Subscriber^ | create_subscriber_with_profile (System::String^ library_name, System::String^ profile_name, SubscriberListener^ listener, StatusMask mask) |
<<eXtension>> Creates a new DDS::Subscriber object using the DDS::PublisherQos associated with the input XML QoS profile. | |
void | delete_subscriber (Subscriber^ %s) |
Deletes an existing DDS::Subscriber. | |
void | get_publishers (PublisherSeq^ publishers) |
<<eXtension>> Allows the application to access all the publishers the participant has. | |
void | get_subscribers (SubscriberSeq^ subscribers) |
<<eXtension>> Allows the application to access all the subscribers the participant has. | |
Topic^ | create_topic (System::String^ topic_name, System::String^ type_name, TopicQos^ qos, TopicListener^ listener, StatusMask mask) |
Creates a DDS::Topic with the desired QoS policies and attaches to it the specified DDS::TopicListener. | |
Topic^ | create_topic_with_profile (System::String^ topic_name, System::String^ type_name, System::String^ library_name, System::String^ profile_name, TopicListener^ listener, StatusMask mask) |
<<eXtension>> Creates a new DDS::Topic object using the DDS::PublisherQos associated with the input XML QoS profile. | |
void | delete_topic (Topic^ %topic) |
Deletes a DDS::Topic. | |
ContentFilteredTopic^ | create_contentfilteredtopic (System::String^ name, Topic^ related_topic, System::String^ filter_expression, StringSeq^ expression_parameters) |
Creates a DDS::ContentFilteredTopic, that can be used to do content-based subscriptions. | |
ContentFilteredTopic^ | create_contentfilteredtopic_with_filter (System::String^ name, Topic^ related_topic, System::String^ filter_expression, StringSeq^ expression_parameters, System::String^ filter_name) |
<<eXtension>> Creates a DDS::ContentFilteredTopic using the specified filter to do content-based subscriptions. | |
void | delete_contentfilteredtopic (ContentFilteredTopic^ %a_contentfilteredtopic) |
Deletes a DDS::ContentFilteredTopic. | |
MultiTopic^ | create_multitopic (System::String^ name, System::String^ type_name, System::String^ subscription_expression, StringSeq^ expression_parameters) |
[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting type. | |
void | delete_multitopic (MultiTopic^ a_multitopic) |
[Not supported (optional)] Deletes a DDS::MultiTopic. | |
Topic^ | find_topic (System::String^ topic_name, Duration_t% timeout) |
Finds an existing (or ready to exist) DDS::Topic, based on its name. | |
ITopicDescription^ | lookup_topicdescription (System::String^ topic_name) |
Looks up an existing, locally created DDS::TopicDescription, based on its name. | |
FlowController^ | create_flowcontroller (System::String^ name, FlowControllerProperty_t^ prop) |
<<eXtension>> Creates a DDS::FlowController with the desired property. | |
void | delete_flowcontroller (FlowController^ %fc) |
<<eXtension>> Deletes an existing DDS::FlowController. | |
FlowController^ | lookup_flowcontroller (System::String^ name) |
<<eXtension>> Looks up an existing locally-created DDS::FlowController, based on its name. | |
Subscriber^ | get_builtin_subscriber () |
Accesses the built-in DDS::Subscriber. | |
void | ignore_participant (InstanceHandle_t% handle) |
Instructs RTI Data Distribution Service to locally ignore a remote DDS::DomainParticipant. | |
void | ignore_topic (InstanceHandle_t% handle) |
Instructs RTI Data Distribution Service to locally ignore a DDS::Topic. | |
void | ignore_publication (InstanceHandle_t% handle) |
Instructs RTI Data Distribution Service to locally ignore a publication. | |
void | ignore_subscription (InstanceHandle_t% handle) |
Instructs RTI Data Distribution Service to locally ignore a subscription. | |
System::Int32 | get_domain_id () |
Get the unique domain identifier. | |
void | get_current_time (Time_t% current_time) |
Returns the current value of the time. | |
void | assert_liveliness () |
Manually asserts the liveliness of this DDS::DomainParticipant. | |
void | delete_contained_entities () |
Delete all the entities that were created by means of the "create" operations on the DDS::DomainParticipant. | |
void | get_discovered_participants (InstanceHandleSeq^ participant_handles) |
Returns list of discovered DDS::DomainParticipant s. | |
void | get_discovered_participant_data (ParticipantBuiltinTopicData^ participant_data, InstanceHandle_t% participant_handle) |
Returns DDS::ParticipantBuiltinTopicData for the specified DDS::DomainParticipant . | |
void | get_discovered_topics (InstanceHandleSeq^ topic_handles) |
Returns list of discovered DDS::Topic objects. | |
void | get_discovered_topic_data (TopicBuiltinTopicData^ topic_data, InstanceHandle_t% topic_handle) |
Returns DDS::TopicBuiltinTopicData for the specified DDS::Topic. | |
System::Boolean | contains_entity (InstanceHandle_t% a_handle) |
Completes successfully with true if the referenced DDS::Entity is contained by the DDS::DomainParticipant. | |
void | set_qos (DomainParticipantQos^ qos) |
Change the QoS of this DomainParticipant. | |
void | set_qos_with_profile (System::String^ library_name, System::String^ profile_name) |
<<eXtension>> Change the QoS of this domain participant using the input XML QoS profile. | |
void | get_qos (DomainParticipantQos^ qos) |
Get the participant QoS. | |
void | add_peer (System::String^ peer_desc_string) |
<<eXtension>> Attempt to contact one or more additional peer participants. | |
void | remove_peer (System::String^ peer_desc_string) |
<<eXtension>> Remove one or more peer participants from the list of peers with which this DDS::DomainParticipant will try to communicate. | |
void | set_listener (DomainParticipantListener^ l, StatusMask mask) |
Sets the participant listener. | |
DomainParticipantListener^ | get_listener () |
Get the participant listener. | |
virtual void | enable () override |
Enables the DDS::Entity. | |
virtual StatusCondition^ | get_statuscondition () override |
Allows access to the DDS::StatusCondition associated with the DDS::Entity. | |
virtual StatusMask | get_status_changes () override |
Retrieves the list of communication statuses in the DDS::Entity that are triggered. | |
virtual InstanceHandle_t | get_instance_handle () override |
Allows access to the DDS::InstanceHandle_t associated with the DDS::Entity. | |
Properties | |
static PublisherQos^ | PUBLISHER_QOS_DEFAULT [get] |
Special value for creating a DDS::Publisher with default QoS. | |
static SubscriberQos^ | SUBSCRIBER_QOS_DEFAULT [get] |
Special value for creating a DDS::Subscriber with default QoS. | |
static TopicQos^ | TOPIC_QOS_DEFAULT [get] |
Special value for creating a DDS::Topic with default QoS. | |
static FlowControllerProperty_t^ | FLOW_CONTROLLER_PROPERTY_DEFAULT [get] |
<<eXtension>> Special value for creating a DDS::FlowController with default property. | |
static System::String^ | SQLFILTER_NAME [get] |
<<eXtension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. | |
static System::String^ | STRINGMATCHFILTER_NAME [get] |
<<eXtension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. |
The DomainParticipant object plays several roles:
- It acts as a container for all other DDS::Entity objects.
- It acts as factory for the DDS::Publisher, DDS::Subscriber, DDS::Topic and DDS::MultiTopic DDS::Entity objects.
- It represents the participation of the application on a communication plane that isolates applications running on the same set of physical computers from each other. A domain establishes a virtual network linking all applications that share the same domainId
and isolating them from applications running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even being aware of each other.
- It provides administration services in the domain, offering operations that allow the application to ignore locally any information about a given participant (ignore_participant()), publication (ignore_publication()), subscription (ignore_subscription()) or topic (ignore_topic()).
The following operations may be called even if the DDS::DomainParticipant is not enabled. (Operations NOT in this list will fail with the value DDS::Retcode_NotEnabled if called on a disabled DomainParticipant).
HelloWorld_publisher.cpp, HelloWorld_subscriber.cpp, and HelloWorldSupport.cpp.
void DDS::DomainParticipant::get_default_datawriter_qos | ( | DataWriterQos^ | qos | ) |
<<eXtension>> Copy the default DDS::DataWriterQos values into the provided DDS::DataWriterQos instance.
The retrieved qos
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_datawriter_qos, or DDS::DomainParticipant::set_default_datawriter_qos_with_profile, or else, if the call was never made, the default values listed in DDS::DataWriterQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_datawriter_qos | ( | DataWriterQos^ | qos | ) |
<<eXtension>> Set the default DataWriterQos values for this DomainParticipant.
This set of default values will be inherited for a newly created DDS::Publisher.
qos | <<in>> Default qos to be set. The special value DDS::Publisher::DATAWRITER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipant::set_default_datawriter_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::set_default_datawriter_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Set the default DDS::DataWriterQos values for this domain participant based on the input XML QoS profile.
This set of default values will be inherited for a newly created DDS::Publisher.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::get_default_datareader_qos | ( | DataReaderQos^ | qos | ) |
<<eXtension>> Copy the default DDS::DataReaderQos values into the provided DDS::DataReaderQos instance.
The retrieved qos
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_datareader_qos, or DDS::DomainParticipant::set_default_datareader_qos_with_profile, or else, if the call was never made, the default values listed in DDS::DataReaderQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_datareader_qos | ( | DataReaderQos^ | qos | ) |
<<eXtension>> Set the default DDS::DataReaderQos values for this domain participant.
This set of default values will be inherited for a newly created DDS::Subscriber.
qos | <<in>> Default qos to be set. The special value DDS::Subscriber::DATAREADER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipant::set_default_datareader_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::set_default_datareader_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Set the default DDS::DataReaderQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be inherited for a newly created DDS::Subscriber.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::get_default_flowcontroller_property | ( | FlowControllerProperty_t^ | prop | ) |
<<eXtension>> Copies the default DDS::FlowControllerProperty_t values for this domain participant into the given DDS::FlowControllerProperty_t instance.
The retrieved property
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_flowcontroller_property, or else, if the call was never made, the default values listed in DDS::FlowControllerProperty_t.
prop | <<in>> Default property to be retrieved. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_flowcontroller_property | ( | FlowControllerProperty_t^ | prop | ) |
<<eXtension>> Set the default DDS::FlowControllerProperty_t values for this domain participant.
This default value will be used for newly created DDS::FlowController if DDS::FLOW_CONTROLLER_PROPERTY_DEFAULT is specified as the property
parameter when DDS::DomainParticipant::create_flowcontroller is called.
qos
parameter.
prop | <<in>> Default property to be set. The special value DDS::FLOW_CONTROLLER_PROPERTY_DEFAULT may be passed as property to indicate that the default property should be reset to the default values the factory would use if DDS::DomainParticipant::set_default_flowcontroller_property had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::register_contentfilter | ( | System::String^ | filter_name, | |
ContentFilter^ | contentfilter | |||
) | [inline] |
<<eXtension>> Register a content filter which can be used to create a DDS::ContentFilteredTopic.
DDS specifies a SQL-like content filter for use by content filtered topics. If this filter does not meet your filtering requirements, you can rgister a custom filter.
To use a custom filter, it must be registered in the following places:
Each filter_name
can only be used to registered a content filter once with a DDS::DomainParticipant.
filter_name | <<in>> Name of the filter. The name must be unique within the DDS::DomainParticipant and must not exceed 255 characters. Cannot be NULL. | |
contentfilter | <<in>> Content filter to be registered. Cannot be NULL. |
One | of the Standard Return Codes |
ContentFilter ^ DDS::DomainParticipant::lookup_contentfilter | ( | System::String^ | filter_name | ) | [inline] |
<<eXtension>> Lookup a content filter previously registered with DDS::DomainParticipant::register_contentfilter.
filter_name | <<in>> Name of the filter. Cannot be NULL. |
void DDS::DomainParticipant::unregister_contentfilter | ( | System::String^ | filter_name | ) | [inline] |
<<eXtension>> Unregister a content filter previously registered with DDS::DomainParticipant::register_contentfilter.
A filter_name
can be unregistered only if it has been previously registered to the DDS::DomainParticipant with DDS::DomainParticipant::register_contentfilter.
The unregistration of filter is not allowed if there are any existing DDS::ContentFilteredTopic objects that are using the filter. If the operation is called on a filter with existing DDS::ContentFilteredTopic objects attached to it, this operation will fail with DDS::Retcode_PreconditionNotMet.
If there are still existing discovered DDS::DataReader s with the same filter_name
and the filter's compile method of the filter have previously been called on the discovered DDS::DataReader s, finalize method of the filter will be called on those discovered DDS::DataReader s before the content filter is unregistered. This means filtering will now be performed on the application that is creating the DDS::DataReader.
filter_name | <<in>> Name of the filter. Cannot be NULL. |
One | of the Standard Return Codes or DDS::Retcode_PreconditionNotMet |
System::String ^ DDS::DomainParticipant::get_default_library | ( | ) |
<<eXtension>> Gets the default XML library associated with a DDS::DomainParticipant.
System::String ^ DDS::DomainParticipant::get_default_profile | ( | ) |
<<eXtension>> Gets the default XML profile associated with a DDS::DomainParticipant.
System::String ^ DDS::DomainParticipant::get_default_profile_library | ( | ) |
<<eXtension>> Gets the library where the default XML QoS profile is contained for a DDS::DomainParticipant.
The default profile library is automatically set when DDS::DomainParticipant::set_default_profile is called.
This library can be different than the DDS::DomainParticipant default library (see DDS::DomainParticipant::get_default_library).
void DDS::DomainParticipant::set_default_library | ( | System::String^ | library_name | ) |
<<eXtension>> Sets the default XML library for a DDS::DomainParticipant.
This method specifies the library that will be used as the default the next time a default library is needed during a call to one of this DomainParticipant's operations.
Any API requiring a library_name as a parameter can use null to refer to the default library.
If the default library is not set, the DDS::DomainParticipant inherits the default from the DDS::DomainParticipantFactory (see DDS::DomainParticipantFactory::set_default_library).
library_name | <<in>> Library name. If library_name is null any previous default is unset. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Sets the default XML profile for a DDS::DomainParticipant.
This method specifies the profile that will be used as the default the next time a default DomainParticipant profile is needed during a call to one of this DomainParticipant's operations. When calling a DDS::DomainParticipant method that requires a profile_name
parameter, you can use NULL to refer to the default profile. (This same information applies to setting a default library.)
If the default profile is not set, the DDS::DomainParticipant inherits the default from the DDS::DomainParticipantFactory (see DDS::DomainParticipantFactory::set_default_profile).
This method does not set the default QoS for entities created by the DDS::DomainParticipant; for this functionality, use the methods set_default_<entity>_qos_with_profile (you may pass in NULL after having called set_default_profile()).
This method does not set the default QoS for newly created DomainParticipants; for this functionality, use DDS::DomainParticipantFactory::set_default_participant_qos_with_profile.
library_name | <<in>> The library name containing the profile. | |
profile_name | <<in>> The profile name. If profile_name is null any previous default is unset. |
One | of the Standard Return Codes |
Publisher ^ DDS::DomainParticipant::get_implicit_publisher | ( | ) |
<<eXtension>> Returns the implicit DDS::Publisher. If an implicit Publisher does not already exist, this creates one.
There can only be one implicit Publisher per DomainParticipant.
The implicit Publisher is created with DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT and no Listener.
This implicit Publisher will be deleted automatically when the following methods are called: DDS::DomainParticipant::delete_contained_entities, or DDS::DomainParticipant::delete_publisher with the implicit publisher as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataWriters that belong to the implicit Publisher, the implicit Publisher will be implicitly deleted.
Subscriber ^ DDS::DomainParticipant::get_implicit_subscriber | ( | ) |
<<eXtension>> Returns the implicit DDS::Subscriber. If an implicit Subscriber does not already exist, this creates one.
There can only be one implicit Subscriber per DomainParticipant.
The implicit Subscriber is created with DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT and no Listener.
This implicit Subscriber will be deleted automatically when the following methods are called: DDS::DomainParticipant::delete_contained_entities, or DDS::DomainParticipant::delete_subscriber with the subscriber as a parameter. Additionally, when a DomainParticipant is deleted, if there are no attached DataReaders that belong to the implicit Subscriber, the implicit Subscriber will be implicitly deleted.
DataWriter ^ DDS::DomainParticipant::create_datawriter | ( | Topic^ | topic, | |
DataWriterQos^ | qos, | |||
DataWriterListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a DDS::DataWriter that will be attached and belong to the implicit DDS::Publisher.
qos
parameter, it is not safe to create the DataWriter while another thread may be simultaneously calling DDS::DomainParticipant::set_default_datawriter_qos.
topic | <<in>> The DDS::Topic that the DDS::DataWriter will be associated with. Cannot be NULL. | |
qos | <<in>> QoS to be used for creating the new DDS::DataWriter. The special value DDS::Publisher::DATAWRITER_QOS_DEFAULT can be used to indicate that the DDS::DataWriter should be created with the default DDS::DataWriterQos set in the implicit DDS::Publisher. The special value DDS::DATAWRITER_QOS_USE_TOPIC_QOS can be used to indicate that the DDS::DataWriter should be created with the combination of the default DDS::DataWriterQos set on the DDS::Publisher and the DDS::TopicQos of the DDS::Topic. Cannot be NULL. | |
listener | <<in>> The listener of the DDS::DataWriter. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS::DataWriterQos for rules on consistency among QoS
DDS::Publisher::DATAWRITER_QOS_DEFAULT
DDS::DATAWRITER_QOS_USE_TOPIC_QOS
DDS::DomainParticipant::create_datawriter_with_profile
DDS::DomainParticipant::get_default_datawriter_qos
DataWriter ^ DDS::DomainParticipant::create_datawriter_with_profile | ( | Topic^ | topic, | |
System::String^ | library_name, | |||
System::String^ | profile_name, | |||
DataWriterListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a DDS::DataWriter using a XML QoS profile that will be attached and belong to the implicit DDS::Publisher.
topic | <<in>> The DDS::Topic that the DDS::DataWriter will be associated with. Cannot be NULL. | |
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). | |
listener | <<in>> The listener of the DDS::DataWriter. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS::DataWriterQos for rules on consistency among QoS
DDS::DomainParticipant::create_datawriter
DDS::DomainParticipant::get_default_datawriter_qos
void DDS::DomainParticipant::delete_datawriter | ( | DataWriter^ % | a_datawriter | ) |
<<eXtension>> Deletes a DDS::DataWriter that belongs to the implicit DDS::Publisher.
The deletion of the DDS::DataWriter will automatically unregister all instances. Depending on the settings of the WRITER_DATA_LIFECYCLE QosPolicy, the deletion of the DDS::DataWriter may also dispose all instances.
a_datawriter | <<in>> The DDS::DataWriter to be deleted. |
One | of the Standard Return Codes or DDS::Retcode_PreconditionNotMet. |
DataReader ^ DDS::DomainParticipant::create_datareader | ( | ITopicDescription^ | topic, | |
DataReaderQos^ | qos, | |||
DataReaderListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a DDS::DataReader that will be attached and belong to the implicit DDS::Subscriber.
qos
parameter, it is not safe to create the datareader while another thread may be simultaneously calling DDS::DomainParticipant::set_default_datareader_qos.
topic | <<in>> The DDS::TopicDescription that the DDS::DataReader will be associated with. Cannot be NULL. | |
qos | <<in>> The qos of the DDS::DataReader. The special value DDS::Subscriber::DATAREADER_QOS_DEFAULT can be used to indicate that the DDS::DataReader should be created with the default DDS::DataReaderQos set in the implicit DDS::Subscriber. If DDS::TopicDescription is of type DDS::Topic or DDS::ContentFilteredTopic, the special value DDS::DATAREADER_QOS_USE_TOPIC_QOS can be used to indicate that the DDS::DataReader should be created with the combination of the default DDS::DataReaderQos set on the implicit DDS::Subscriber and the DDS::TopicQos (in the case of a DDS::ContentFilteredTopic, the DDS::TopicQos of the related DDS::Topic). if DDS::DATAREADER_QOS_USE_TOPIC_QOS is used, topic cannot be a DDS::MultiTopic. Cannot be NULL. | |
listener | <<in>> The listener of the DDS::DataReader. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS::DataReaderQos for rules on consistency among QoS
DDS::DomainParticipant::create_datareader_with_profile
DDS::DomainParticipant::get_default_datareader_qos
DataReader ^ DDS::DomainParticipant::create_datareader_with_profile | ( | ITopicDescription^ | topic, | |
System::String^ | library_name, | |||
System::String^ | profile_name, | |||
DataReaderListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a DDS::DataReader using a XML QoS profile that will be attached and belong to the implicit DDS::Subscriber.
topic | <<in>> The DDS::TopicDescription that the DDS::DataReader will be associated with. Cannot be NULL. | |
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). | |
listener | <<in>> The listener of the DDS::DataReader. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
Specifying QoS on entities for information on setting QoS before entity creation
DDS::DataReaderQos for rules on consistency among QoS
DDS::DomainParticipant::create_datareader
DDS::DomainParticipant::get_default_datareader_qos
void DDS::DomainParticipant::delete_datareader | ( | DataReader^ % | a_datareader | ) |
<<eXtension>> Deletes a DDS::DataReader that belongs to the implicit DDS::Subscriber.
a_datareader | <<in>> The DDS::DataReader to be deleted. |
One | of the Standard Return Codes or DDS::Retcode_PreconditionNotMet. |
void DDS::DomainParticipant::get_default_topic_qos | ( | TopicQos^ | qos | ) |
Copies the default DDS::TopicQos values for this domain participant into the given DDS::TopicQos instance.
The retrieved qos
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_topic_qos, or else, if the call was never made, the default values listed in DDS::TopicQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<in>> Default qos to be retrieved. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_topic_qos | ( | TopicQos^ | qos | ) |
Set the default DDS::TopicQos values for this domain participant.
This default value will be used for newly created DDS::Topic if DDS::DomainParticipant::TOPIC_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_topic is called.
qos
parameter.
qos | <<in>> Default qos to be set. The special value DDS::DomainParticipant::TOPIC_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipant::set_default_topic_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::set_default_topic_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Set the default DDS::TopicQos values for this domain participant based on the input XML QoS profile.
This default value will be used for newly created DDS::Topic if DDS::DomainParticipant::TOPIC_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_topic is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::get_default_publisher_qos | ( | PublisherQos^ | qos | ) |
Copy the default DDS::PublisherQos values into the provided DDS::PublisherQos instance.
The retrieved qos
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_publisher_qos, or DDS::DomainParticipant::set_default_publisher_qos_with_profile, or else, if the call was never made, the default values listed in DDS::PublisherQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
If DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_topic is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling DDS::DomainParticipant::get_default_publisher_qos, will be used to create the DDS::Publisher.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_publisher_qos | ( | PublisherQos^ | qos | ) |
Set the default DDS::PublisherQos values for this DomainParticipant.
This set of default values will be used for a newly created DDS::Publisher if DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_publisher is called.
qos
parameter.
qos | <<in>> Default qos to be set. The special value DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipant::set_default_publisher_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::set_default_publisher_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Set the default DDS::PublisherQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created DDS::Publisher if DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_publisher is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::get_default_subscriber_qos | ( | SubscriberQos^ | qos | ) |
Copy the default DDS::SubscriberQos values into the provided DDS::SubscriberQos instance.
The retrieved qos
will match the set of values specified on the last successful call to DDS::DomainParticipant::set_default_subscriber_qos, or DDS::DomainParticipant::set_default_subscriber_qos_with_profile, or else, if the call was never made, the default values listed in DDS::SubscriberQos.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
If DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_subscriber is called, the default value of the QoS set in the factory, equivalent to the value obtained by calling DDS::DomainParticipant::get_default_subscriber_qos, will be used to create the DDS::Subscriber.
qos | <<inout>> Qos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_default_subscriber_qos | ( | SubscriberQos^ | qos | ) |
Set the default DDS::SubscriberQos values for this Domain{articipant.
This set of default values will be used for a newly created DDS::Subscriber if DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_subscriber is called.
qos
parameter.
qos | <<in>> Default qos to be set. The special value DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT may be passed as qos to indicate that the default QoS should be reset back to the initial values the factory would used if DDS::DomainParticipant::set_default_subscriber_qos had never been called. Cannot be NULL. |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
void DDS::DomainParticipant::set_default_subscriber_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Set the default DDS::SubscriberQos values for this DomainParticipant based on the input XML QoS profile.
This set of default values will be used for a newly created DDS::Subscriber if DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT is specified as the qos
parameter when DDS::DomainParticipant::create_subscriber is called.
qos
parameter. library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). |
One | of the Standard Return Codes, or DDS::Retcode_InconsistentPolicy |
Publisher ^ DDS::DomainParticipant::create_publisher | ( | PublisherQos^ | qos, | |
PublisherListener^ | listener, | |||
StatusMask | mask | |||
) |
Creates a DDS::Publisher with the desired QoS policies and attaches to it the specified DDS::PublisherListener.
qos
, it is not safe to create the publisher while another thread may be simultaneously calling DDS::DomainParticipant::set_default_publisher_qos.
qos | <<in>> QoS to be used for creating the new DDS::Publisher. The special value DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT can be used to indicate that the DDS::Publisher should be created with the default DDS::PublisherQos set in the DDS::DomainParticipant. Cannot be NULL. | |
listener | <<in>>. Listener to be attached to the newly created DDS::Publisher. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::PublisherQos for rules on consistency among QoS
DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT
DDS::DomainParticipant::create_publisher_with_profile
Publisher ^ DDS::DomainParticipant::create_publisher_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name, | |||
PublisherListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a new DDS::Publisher object using the DDS::PublisherQos associated with the input XML QoS profile.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). | |
listener | <<in>>. Listener to be attached to the newly created DDS::Publisher. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::PublisherQos for rules on consistency among QoS
DDS::DomainParticipant::create_publisher
void DDS::DomainParticipant::delete_publisher | ( | Publisher^ % | p | ) |
Deletes an existing DDS::Publisher.
DDS::Publisher must have been created by this DDS::DomainParticipant, or else it will fail with DDS::Retcode_PreconditionNotMet.
p | <<in>> DDS::Publisher to be deleted. |
One | of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet. |
Subscriber ^ DDS::DomainParticipant::create_subscriber | ( | SubscriberQos^ | qos, | |
SubscriberListener^ | listener, | |||
StatusMask | mask | |||
) |
Creates a DDS::Subscriber with the desired QoS policies and attaches to it the specified DDS::SubscriberListener.
qos
, it is not safe to create the subscriber while another thread may be simultaneously calling DDS::DomainParticipant::set_default_subscriber_qos.
qos | <<in>> QoS to be used for creating the new DDS::Subscriber. The special value DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT can be used to indicate that the DDS::Subscriber should be created with the default DDS::SubscriberQos set in the DDS::DomainParticipant. Cannot be NULL. | |
listener | <<in>>. Listener to be attached to the newly created DDS::Subscriber. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::SubscriberQos for rules on consistency among QoS
DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT
DDS::DomainParticipant::create_subscriber_with_profile
Subscriber ^ DDS::DomainParticipant::create_subscriber_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name, | |||
SubscriberListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a new DDS::Subscriber object using the DDS::PublisherQos associated with the input XML QoS profile.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). | |
listener | <<in>>. Listener to be attached to the newly created DDS::Subscriber. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::SubscriberQos for rules on consistency among QoS
DDS::DomainParticipant::create_subscriber
void DDS::DomainParticipant::delete_subscriber | ( | Subscriber^ % | s | ) |
Deletes an existing DDS::Subscriber.
The DDS::Subscriber must have been created by this DDS::DomainParticipant, or else it will fail with DDS::Retcode_PreconditionNotMet.
s | <<in>> DDS::Subscriber to be deleted. |
One | of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet. |
void DDS::DomainParticipant::get_publishers | ( | PublisherSeq^ | publishers | ) |
<<eXtension>> Allows the application to access all the publishers the participant has.
If the sequence doesn't own its buffer, and its maximum is less than the total number of publishers, it will be filled up to its maximum, and fail with DDS::Retcode_OutOfResources.
publishers | <<inout>> a PublisherSeq object where the set or list of publishers will be returned |
void DDS::DomainParticipant::get_subscribers | ( | SubscriberSeq^ | subscribers | ) |
<<eXtension>> Allows the application to access all the subscribers the participant has.
If the sequence doesn't own its buffer, and its maximum is less than the total number of subscribers, it will be filled up to its maximum, and fail with DDS::Retcode_OutOfResources.
subscribers | <<inout>> a SubscriberSeq object where the set or list of subscribers will be returned |
Topic ^ DDS::DomainParticipant::create_topic | ( | System::String^ | topic_name, | |
System::String^ | type_name, | |||
TopicQos^ | qos, | |||
TopicListener^ | listener, | |||
StatusMask | mask | |||
) |
Creates a DDS::Topic with the desired QoS policies and attaches to it the specified DDS::TopicListener.
topic_name
attached to the same DDS::DomainParticipant. If the application attempts this, this method will fail and return a NULL topic. The specified QoS policies must be consistent, or the operation will fail and no DDS::Topic will be created.
Prior to creating a DDS::Topic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport::register_type operation on a derived class of the DDS::TypeSupport interface.
qos
, it is not safe to create the topic while another thread may be simultaneously calling DDS::DomainParticipant::set_default_topic_qos.
topic_name | <<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL. | |
type_name | <<in>> The type to which the new DDS::Topic will be bound. Cannot be NULL. | |
qos | <<in>> QoS to be used for creating the new DDS::Topic. The special value DDS::DomainParticipant::TOPIC_QOS_DEFAULT can be used to indicate that the DDS::Topic should be created with the default DDS::TopicQos set in the DDS::DomainParticipant. Cannot be NULL. | |
listener | <<in>>. Listener to be attached to the newly created DDS::Topic. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::TopicQos for rules on consistency among QoS
DDS::DomainParticipant::TOPIC_QOS_DEFAULT
DDS::DomainParticipant::create_topic_with_profile
Topic ^ DDS::DomainParticipant::create_topic_with_profile | ( | System::String^ | topic_name, | |
System::String^ | type_name, | |||
System::String^ | library_name, | |||
System::String^ | profile_name, | |||
TopicListener^ | listener, | |||
StatusMask | mask | |||
) |
<<eXtension>> Creates a new DDS::Topic object using the DDS::PublisherQos associated with the input XML QoS profile.
topic_name
attached to the same DDS::DomainParticipant. If the application attempts this, this method will fail and return a NULL topic. The DDS::TopicQos in the input profile must be consistent, or the operation will fail and no DDS::Topic will be created.
Prior to creating a DDS::Topic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport::register_type operation on a derived class of the DDS::TypeSupport interface.
topic_name | <<in>> Name for the new topic, must not exceed 255 characters. Cannot be NULL. | |
type_name | <<in>> The type to which the new DDS::Topic will be bound. Cannot be NULL. | |
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipant::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipant::set_default_profile). | |
listener | <<in>>. Listener to be attached to the newly created DDS::Topic. | |
mask | <<in>>. Changes of communication status to be invoked on the listener. |
DDS::TopicQos for rules on consistency among QoS
DDS::DomainParticipant::create_topic
void DDS::DomainParticipant::delete_topic | ( | Topic^ % | topic | ) |
Deletes a DDS::Topic.
Make sure no objects are using the topic. More specifically, there must be no existing DDS::DataReader, DDS::DataWriter, DDS::ContentFilteredTopic, or DDS::MultiTopic objects belonging to the same DDS::DomainParticipant that are using the DDS::Topic. If delete_topic is called on a DDS::Topic with any of these existing objects attached to it, it will fail with DDS::Retcode_PreconditionNotMet.
topic | <<in>> DDS::Topic to be deleted. |
One | of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet |
ContentFilteredTopic ^ DDS::DomainParticipant::create_contentfilteredtopic | ( | System::String^ | name, | |
Topic^ | related_topic, | |||
System::String^ | filter_expression, | |||
StringSeq^ | expression_parameters | |||
) |
Creates a DDS::ContentFilteredTopic, that can be used to do content-based subscriptions.
The DDS::ContentFilteredTopic only relates to samples published under that DDS::Topic, filtered according to their content. The filtering is done by means of evaluating a logical expression that involves the values of some of the data-fields in the sample. The logical expression derived from the filter_expression
and expression_parameters
arguments.
Queries and Filters Syntax describes the syntax of filter_expression
and expression_parameters
.
topic_name
attached to the same DDS::DomainParticipant. If the application attempts this, this method will fail and returns NULL.
If related_topic
does not belong to this DDS::DomainParticipant, this operation returns NULL.
This function will create a content filter using the builtin SQL filter which implements a superset of the DDS specification. This filter requires that all IDL types have been compiled with typecodes. If this precondition is not met, this operation returns NULL. Do not use rtiddsgen's -notypecode option if you want to use the builtin SQL filter.
name | <<in>> Name for the new content filtered topic, must not exceed 255 characters. Cannot be NULL. | |
related_topic | <<in>> DDS::Topic to be filtered. Cannot be NULL. | |
filter_expression | <<in>> Cannot be NULL | |
expression_parameters | <<in>> Cannot be NULL.An empty sequence must be used if the filter expression does not contain any parameters. Length of sequence cannot be greater than 100. |
ContentFilteredTopic ^ DDS::DomainParticipant::create_contentfilteredtopic_with_filter | ( | System::String^ | name, | |
Topic^ | related_topic, | |||
System::String^ | filter_expression, | |||
StringSeq^ | expression_parameters, | |||
System::String^ | filter_name | |||
) |
<<eXtension>> Creates a DDS::ContentFilteredTopic using the specified filter to do content-based subscriptions.
name | <<in>> Name for the new content filtered topic. Cannot exceed 255 characters. Cannot be NULL. | |
related_topic | <<in>> DDS::Topic to be filtered. Cannot be NULL. | |
filter_expression | <<in>> Cannot be NULL. | |
expression_parameters | <<in>> Cannot be NULL.. An empty sequence must be used if the filter expression does not contain any parameters. Length of the sequence cannot be greater than 100. | |
filter_name | <<in>> Name of content filter to use. Must previously have been registered with DDS::DomainParticipant::register_contentfilter on the same DDS::DomainParticipant. Cannot be NULL. |
void DDS::DomainParticipant::delete_contentfilteredtopic | ( | ContentFilteredTopic^ % | a_contentfilteredtopic | ) |
Deletes a DDS::ContentFilteredTopic.
The DDS::ContentFilteredTopic must be created by this DDS::DomainParticipant, or else this operation will fail with DDS::Retcode_PreconditionNotMet.
a_contentfilteredtopic | <<in>> |
One | of the Standard Return Codes or DDS::Retcode_PreconditionNotMet |
MultiTopic ^ DDS::DomainParticipant::create_multitopic | ( | System::String^ | name, | |
System::String^ | type_name, | |||
System::String^ | subscription_expression, | |||
StringSeq^ | expression_parameters | |||
) | [inline] |
[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting type.
The resulting type is specified by the type_name
argument. The list of topics and the logic used to combine, filter, and rearrange the information from each DDS::Topic are specified using the subscription_expression
and expression_parameters
arguments.
Queries and Filters Syntax describes the syntax of subscription_expression
and expression_parameters
.
name
attached to the same DDS::DomainParticipant. If the application attempts this, this method will fail and return NULL. Prior to creating a DDS::MultiTopic, the type must have been registered with RTI Data Distribution Service. This is done using the FooTypeSupport::register_type operation on a derived class of the DDS::TypeSupport interface. Otherwise, this method will return NULL.
name | <<in>> Name of the newly create DDS::MultiTopic. Cannot be NULL. | |
type_name | <<in>> Cannot be NULL. | |
subscription_expression | <<in>> Cannot be NULL. | |
expression_parameters | <<in>> Cannot be NULL. |
void DDS::DomainParticipant::delete_multitopic | ( | MultiTopic^ | a_multitopic | ) | [inline] |
[Not supported (optional)] Deletes a DDS::MultiTopic.
The DDS::MultiTopic must be created by this DDS::DomainParticipant, or else this operation will fail with DDS::Retcode_PreconditionNotMet.
a_multitopic | <<in>> |
DDS::Retcode_Unsupported |
Topic ^ DDS::DomainParticipant::find_topic | ( | System::String^ | topic_name, | |
Duration_t% | timeout | |||
) |
Finds an existing (or ready to exist) DDS::Topic, based on its name.
This call can be used to block for a specified duration to wait for the DDS::Topic to be created.
If the requested DDS::Topic already exists, it is returned. Otherwise, find_topic() waits until another thread creates it or else returns when the specified timeout occurs.
find_topic() is useful when multiple threads are concurrently creating and looking up topics. In that case, one thread can call find_topic() and, if another thread has not yet created the topic being looked up, it can wait for some period of time for it to do so. In almost all other cases, it is more straightforward to call DDS::DomainParticipant::lookup_topicdescription.
The DDS::DomainParticipant must already be enabled.
Note: Each DDS::Topic obtained by DDS::DomainParticipant::find_topic must also be deleted by means of DDS::DomainParticipant::delete_topic. If DDS::Topic is obtained multiple times by means of DDS::DomainParticipant::find_topic or DDS::DomainParticipant::create_topic, it must also be deleted that same number of times using DDS::DomainParticipant::delete_topic.
topic_name | <<in>> Name of the DDS::Topic to search for. Cannot be NULL. | |
timeout | <<in>> The time to wait if the DDS::Topic does not exist already. Cannot be NULL. |
ITopicDescription ^ DDS::DomainParticipant::lookup_topicdescription | ( | System::String^ | topic_name | ) |
Looks up an existing, locally created DDS::TopicDescription, based on its name.
DDS::TopicDescription is the base class for DDS::Topic, DDS::MultiTopic and DDS::ContentFilteredTopic. So you can narrow the DDS::TopicDescription returned from this operation to a DDS::Topic or DDS::ContentFilteredTopic as appropriate.
Unlike DDS::DomainParticipant::find_topic, which logically returns a new DDS::Topic object that must be independently deleted, this operation returns a reference to the original local object.
The DDS::DomainParticipant does not have to be enabled when you call lookup_topicdescription().
The returned topic may be either enabled or disabled.
topic_name | <<in>> Name of DDS::TopicDescription to search for. This string must be no more than 255 characters; it cannot be NULL. |
FlowController ^ DDS::DomainParticipant::create_flowcontroller | ( | System::String^ | name, | |
FlowControllerProperty_t^ | prop | |||
) |
<<eXtension>> Creates a DDS::FlowController with the desired property.
The created DDS::FlowController is associated with a DDS::DataWriter via DDS::PublishModeQosPolicy::flow_controller_name. A single DDS::FlowController may service multiple DDS::DataWriter instances, even if they belong to a different DDS::Publisher. The property
determines how the DDS::FlowController shapes the network traffic.
property
must be consistent, or the operation will fail and no DDS::FlowController will be created. property
, it is not safe to create the flow controller while another thread may be simultaneously calling DDS::DomainParticipant::set_default_flowcontroller_property or trying to lookup that flow controller with DDS::DomainParticipant::lookup_flowcontroller.
name | <<in>> name of the DDS::FlowController to create. A DDS::DataWriter is associated with a DDS::FlowController by name. Limited to 255 characters. | |
prop | <<in>> property to be used for creating the new DDS::FlowController. The special value DDS::FLOW_CONTROLLER_PROPERTY_DEFAULT can be used to indicate that the DDS::FlowController should be created with the default DDS::FlowControllerProperty_t set in the DDS::DomainParticipant. Cannot be NULL. |
DDS::FLOW_CONTROLLER_PROPERTY_DEFAULT
void DDS::DomainParticipant::delete_flowcontroller | ( | FlowController^ % | fc | ) |
<<eXtension>> Deletes an existing DDS::FlowController.
The DDS::FlowController must have been created by this DDS::DomainParticipant, or else it will fail with DDS::Retcode_PreconditionNotMet.
fc | <<in>> The DDS::FlowController to be deleted. |
One | of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet. |
FlowController ^ DDS::DomainParticipant::lookup_flowcontroller | ( | System::String^ | name | ) |
<<eXtension>> Looks up an existing locally-created DDS::FlowController, based on its name.
Looks up a previously created DDS::FlowController, including the built-in ones. Once a DDS::FlowController has been deleted, subsequent lookups will fail.
name | <<in>> Name of DDS::FlowController to search for. Limited to 255 characters. Cannot be NULL. |
Subscriber ^ DDS::DomainParticipant::get_builtin_subscriber | ( | ) |
Accesses the built-in DDS::Subscriber.
Each DDS::DomainParticipant contains several built-in DDS::Topic objects as well as corresponding DDS::DataReader objects to access them. All of these DDS::DataReader objects belong to a single built-in DDS::Subscriber.
The built-in Topics are used to communicate information about other DDS::DomainParticipant, DDS::Topic, DDS::DataReader, and DDS::DataWriter objects.
The built-in subscriber is created when this operation is called for the first time. The built-in subscriber is deleted automatically when the DDS::DomainParticipant is deleted.
void DDS::DomainParticipant::ignore_participant | ( | InstanceHandle_t% | handle | ) |
Instructs RTI Data Distribution Service to locally ignore a remote DDS::DomainParticipant.
From the time of this call onwards, RTI Data Distribution Service will locally behave as if the remote participant did not exist. This means it will ignore any topic, publication, or subscription that originates on that DDS::DomainParticipant.
There is no way to reverse this operation.
This operation can be used in conjunction with the discovery of remote participants offered by means of the DDS::ParticipantBuiltinTopicData to provide access control.
Application data can be associated with a DDS::DomainParticipant by means of the USER_DATA policy. This application data is propagated as a field in the built-in topic and can be used by an application to implement its own access control policy.
The DDS::DomainParticipant to ignore is identified by the handle
argument. This handle
is the one that appears in the DDS::SampleInfo retrieved when reading the data-samples available for the built-in DDS::DataReader to the DDS::DomainParticipant
topic. The built-in DDS::DataReader is read with the same DDS::TypedDataReader::read and DDS::TypedDataReader::take operations used for any DDS::DataReader.
handle | <<in>> DDS::InstanceHandle_t of the DDS::DomainParticipant to be ignored. Cannot be NULL. |
One | of the Standard Return Codes, DDS::Retcode_OutOfResources, DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::ignore_topic | ( | InstanceHandle_t% | handle | ) |
Instructs RTI Data Distribution Service to locally ignore a DDS::Topic.
This means it will locally ignore any publication, or subscription to the DDS::Topic.
There is no way to reverse this operation.
This operation can be used to save local resources when the application knows that it will never publish or subscribe to data under certain topics.
The DDS::Topic to ignore is identified by the handle
argument. This is the handle of a DDS::Topic that appears in the DDS::SampleInfo retrieved when reading data samples from the built-in DDS::DataReader for the DDS::Topic.
handle | <<in>> Handle of the DDS::Topic to be ignored. Cannot be NULL. |
One | of the Standard Return Codes, DDS::Retcode_OutOfResources or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::ignore_publication | ( | InstanceHandle_t% | handle | ) |
Instructs RTI Data Distribution Service to locally ignore a publication.
A publication is defined by the association of a topic name, user data, and partition set on the DDS::Publisher (see DDS::PublicationBuiltinTopicData). After this call, any data written by that publication's DDS::DataWriter will be ignored.
This operation can be used to ignore local and remote DataWriters.
The publication (DataWriter) to ignore is identified by the handle
argument.
handle
can be obtained from the DDS::SampleInfo retrieved when reading data samples from the built-in DDS::DataReader for the publication topic. handle
can be obtained by calling DDS::Entity::get_instance_handle for the local DataWriter.
handle | <<in>> Handle of the DDS::DataWriter to be ignored. Cannot be NULL. |
One | of the Standard Return Codes, DDS::Retcode_OutOfResources or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::ignore_subscription | ( | InstanceHandle_t% | handle | ) |
Instructs RTI Data Distribution Service to locally ignore a subscription.
A subscription is defined by the association of a topic name, user data, and partition set on the DDS::Subscriber (see DDS::SubscriptionBuiltinTopicData). After this call, any data received related to that subscription's DDS::DataReader will be ignored.
This operation can be used to ignore local and remote DataReaders.
The subscription to ignore is identified by the handle
argument.
handle
can be obtained from the DDS::SampleInfo retrieved when reading data samples from the built-in DDS::DataReader for the subscription topic. handle
can be obtained by calling DDS::Entity::get_instance_handle for the local DataReader.
handle | <<in>> Handle of the DDS::DataReader to be ignored. Cannot be NULL. |
One | of the Standard Return Codes, DDS::Retcode_OutOfResources or DDS::Retcode_NotEnabled |
System::Int32 DDS::DomainParticipant::get_domain_id | ( | ) |
Get the unique domain identifier.
This operation retrieves the domain_id
used to create the DDS::DomainParticipant. The domain_id
identifies the DDS domain to which the DDS::DomainParticipant belongs. Each DDS domain represents a separate data 'communication plane' isolated from other domains.
domainId
that was used to create the domain void DDS::DomainParticipant::get_current_time | ( | Time_t% | current_time | ) |
Returns the current value of the time.
The current value of the time that RTI Data Distribution Service uses to time-stamp DDS::DataWriter and to set the reception-timestamp for the data updates that it receives.
current_time | <<inout>> Current time to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::assert_liveliness | ( | ) |
Manually asserts the liveliness of this DDS::DomainParticipant.
This is used in combination with the DDS::LivelinessQosPolicy to indicate to RTI Data Distribution Service that the entity remains active.
You need to use this operation if the DDS::DomainParticipant conatins DDS::DataWriter entities with the DDS::LivelinessQosPolicy::kind set to DDS::LivelinessQosPolicyKind::MANUAL_BY_PARTICIPANT_LIVELINESS_QOS and it only affects the liveliness of those DDS::DataWriter entities. Otherwise, it has no effect.
Note: writing data via the DDS::TypedDataWriter::write or DDS::TypedDataWriter::write_w_timestamp operation asserts liveliness on the DDS::DataWriter itself and its DDS::DomainParticipant. Consequently the use of assert_liveliness() is only needed if the application is not writing data regularly.
One | of the Standard Return Codes, or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::delete_contained_entities | ( | ) |
Delete all the entities that were created by means of the "create" operations on the DDS::DomainParticipant.
This operation deletes all contained DDS::Publisher (including an implicit Publisher, if one exists), DDS::Subscriber (including implicit subscriber), DDS::Topic, DDS::ContentFilteredTopic, and DDS::MultiTopic objects.
Prior to deleting each contained entity, this operation will recursively call the corresponding delete_contained_entities operation on each contained entity (if applicable). This pattern is applied recursively. In this manner the operation delete_contained_entities() on the DDS::DomainParticipant will end up deleting all the entities recursively contained in the DDS::DomainParticipant, that is also the DDS::DataWriter, DDS::DataReader, as well as the DDS::QueryCondition and DDS::ReadCondition objects belonging to the contained DDS::DataReader.
The operation will fail with DDS::Retcode_PreconditionNotMet if any of the contained entities is in a state where it cannot be deleted.
If delete_contained_entities() completes successfully, the application may delete the DDS::DomainParticipant knowing that it has no contained entities.
One | of the Standard Return Codes, or DDS::Retcode_PreconditionNotMet. |
void DDS::DomainParticipant::get_discovered_participants | ( | InstanceHandleSeq^ | participant_handles | ) |
Returns list of discovered DDS::DomainParticipant s.
This operation retrieves the list of DDS::DomainParticipant s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DDS::DomainParticipant::ignore_participant operation.
participant_handles | <<inout>> DDS::InstanceHandleSeq to be filled with handles of the discovered DDS::DomainParticipant s |
One | of the Standard Return Codes or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::get_discovered_participant_data | ( | ParticipantBuiltinTopicData^ | participant_data, | |
InstanceHandle_t% | participant_handle | |||
) |
Returns DDS::ParticipantBuiltinTopicData for the specified DDS::DomainParticipant .
This operation retrieves information on a DDS::DomainParticipant that has been discovered on the network. The participant must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the DDS::DomainParticipant::ignore_participant operation.
The participant_handle
must correspond to such a DomainParticipant. Otherwise, the operation will fail with PRECONDITION_NOT_MET.
Use the operation DDS::DomainParticipant::get_discovered_participants to find the DDS::DomainParticipant s that are currently discovered.
Note: This operation does not retrieve the DDS::ParticipantBuiltinTopicData::property. This information is available through DDS::DataReaderListener::on_data_available() (if a reader listener is installed on the DDS::ParticipantBuiltinTopicDataDataReader).
participant_data | <<inout>> DDS::ParticipantBuiltinTopicData to be filled with the specified DDS::DomainParticipant 's data. | |
participant_handle | <<in>> DDS::InstanceHandle_t of DDS::DomainParticipant. |
One | of the Standard Return Codes, DDS::Retcode_PreconditionNotMet or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::get_discovered_topics | ( | InstanceHandleSeq^ | topic_handles | ) |
Returns list of discovered DDS::Topic objects.
This operation retrieves the list of DDS::Topic s that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DDS::DomainParticipant::ignore_topic operation.
topic_handles | <<inout>> DDS::InstanceHandleSeq to be filled with handles of the discovered DDS::Topic objects |
One | of the Standard Return Codes or DDS::Retcode_NotEnabled |
void DDS::DomainParticipant::get_discovered_topic_data | ( | TopicBuiltinTopicData^ | topic_data, | |
InstanceHandle_t% | topic_handle | |||
) |
Returns DDS::TopicBuiltinTopicData for the specified DDS::Topic.
This operation retrieves information on a DDS::Topic that has been discovered by the local Participant and must not have been "ignored" by means of the DDS::DomainParticipant::ignore_topic operation.
The topic_handle
must correspond to such a topic. Otherwise, the operation will fail with DDS::Retcode_PreconditionNotMet.
This call is not supported for remote topics. If a remote topic_handle
is used, the operation will fail with DDS::Retcode_Unsupported.
Use the operation DDS::DomainParticipant::get_discovered_topics to find the topics that are currently discovered.
topic_data | <<inout>> DDS::TopicBuiltinTopicData to be filled with the specified DDS::Topic's data. | |
topic_handle | <<in>> DDS::InstanceHandle_t of DDS::Topic. |
One | of the Standard Return Codes, DDS::Retcode_PreconditionNotMet or DDS::Retcode_NotEnabled |
System::Boolean DDS::DomainParticipant::contains_entity | ( | InstanceHandle_t% | a_handle | ) |
Completes successfully with true if the referenced DDS::Entity is contained by the DDS::DomainParticipant.
This operation checks whether or not the given a_handle
represents an DDS::Entity that was created from the DDS::DomainParticipant. The containment applies recursively. That is, it applies both to entities (DDS::TopicDescription, DDS::Publisher, or DDS::Subscriber) created directly using the DDS::DomainParticipant as well as entities created using a contained DDS::Publisher, or DDS::Subscriber as the factory, and so forth.
The instance
handle for an DDS::Entity may be obtained from built-in topic data, from various statuses, or from the operation DDS::Entity::get_instance_handle.
a_handle | <<in>> DDS::InstanceHandle_t of the DDS::Entity to be checked. |
void DDS::DomainParticipant::set_qos | ( | DomainParticipantQos^ | qos | ) |
Change the QoS of this DomainParticipant.
The DDS::DomainParticipantQos::user_data and DDS::DomainParticipantQos::entity_factory can be changed. The other policies are immutable.
qos | <<in>> Set of policies to be applied to DDS::DomainParticipant. Policies must be consistent. Immutable policies cannot be changed after DDS::DomainParticipant is enabled. The special value DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT can be used to indicate that the QoS of the DDS::DomainParticipant should be changed to match the current default DDS::DomainParticipantQos set in the DDS::DomainParticipantFactory. Cannot be NULL. |
One | of the Standard Return Codes, DDS::Retcode_ImmutablePolicy if immutable policy is changed, or DDS::Retcode_InconsistentPolicy if policies are inconsistent |
void DDS::DomainParticipant::set_qos_with_profile | ( | System::String^ | library_name, | |
System::String^ | profile_name | |||
) |
<<eXtension>> Change the QoS of this domain participant using the input XML QoS profile.
The DDS::DomainParticipantQos::user_data and DDS::DomainParticipantQos::entity_factory can be changed. The other policies are immutable.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Data Distribution Service will use the default library (see DDS::DomainParticipantFactory::set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Data Distribution Service will use the default profile (see DDS::DomainParticipantFactory::set_default_profile). |
One | of the Standard Return Codes, DDS::Retcode_ImmutablePolicy if immutable policy is changed, or DDS::Retcode_InconsistentPolicy if policies are inconsistent |
void DDS::DomainParticipant::get_qos | ( | DomainParticipantQos^ | qos | ) |
Get the participant QoS.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> QoS to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::add_peer | ( | System::String^ | peer_desc_string | ) |
<<eXtension>> Attempt to contact one or more additional peer participants.
Add the given peer description to the list of peers with which this DDS::DomainParticipant will try to communicate.
This method may be called at any time after this DDS::DomainParticipant has been created (before or after it has been enabled).
If this method is called after DDS::Entity::enable, an attempt will be made to contact the new peer(s) immediately.
If this method is called before the DomainParticipant is enabled, the peer description will simply be added to the list that was populated by DDS::DiscoveryQosPolicy::initial_peers; the first attempted contact will take place after this DDS::DomainParticipant is enabled.
Adding a peer description with this method does not guarantee that any peer(s) discovered as a result will exactly correspond to those described:
To remove specific peer locators, you may use DDS::DomainParticipant::remove_peer. If a peer is removed, the add_peer operation will add it back to the list of peers.
To stop communicating with a peer DDS::DomainParticipant that has been discovered, use DDS::DomainParticipant::ignore_participant.
Adding a peer description with this method has no effect on the DDS::DiscoveryQosPolicy::initial_peers that may be subsequently retrieved with DDS::DomainParticipant::get_qos() (because DDS::DiscoveryQosPolicy is immutable).
peer_desc_string | <<in>> New peer descriptor to be added. The format is specified in Peer Descriptor Format. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::remove_peer | ( | System::String^ | peer_desc_string | ) |
<<eXtension>> Remove one or more peer participants from the list of peers with which this DDS::DomainParticipant will try to communicate.
This method may be called any time after this DDS::DomainParticipant has been enabled
Calling this method has the following effects:
Removing a peer description with this method has no effect on the DDS::DiscoveryQosPolicy::initial_peers that may be subsequently retrieved with DDS::DomainParticipant::get_qos() (because DDS::DiscoveryQosPolicy is immutable).
peer_desc_string | <<in>> Peer descriptor to be removed. The format is specified in Peer Descriptor Format. Cannot be NULL. |
One | of the Standard Return Codes |
void DDS::DomainParticipant::set_listener | ( | DomainParticipantListener^ | l, | |
StatusMask | mask | |||
) |
Sets the participant listener.
l | <<in>> Listener to be installed on entity. | |
mask | <<in>> Changes of communication status to be invoked on the listener. |
One | of the Standard Return Codes |
DomainParticipantListener ^ DDS::DomainParticipant::get_listener | ( | ) |
Get the participant listener.
virtual void DDS::DomainParticipant::enable | ( | ) | [override, virtual] |
Enables the DDS::Entity.
This operation enables the Entity. Entity objects can be created either enabled or disabled. This is controlled by the value of the ENTITY_FACTORY QoS policy on the corresponding factory for the DDS::Entity.
By default, ENTITY_FACTORY is set so that it is not necessary to explicitly call DDS::Entity::enable on newly created entities.
The DDS::Entity::enable operation is idempotent. Calling enable on an already enabled Entity returns OK and has no effect.
If a DDS::Entity has not yet been enabled, the following kinds of operations may be invoked on it:
It is legal to delete an DDS::Entity that has not been enabled by calling the proper operation on its factory.
Entities created from a factory that is disabled are created disabled, regardless of the setting of the DDS::EntityFactoryQosPolicy.
Calling enable on an Entity whose factory is not enabled will fail and return DDS::Retcode_PreconditionNotMet.
If DDS::EntityFactoryQosPolicy::autoenable_created_entities is TRUE, the enable operation on a factory will automatically enable all entities created from that factory.
Listeners associated with an entity are not called until the entity is enabled.
Conditions associated with a disabled entity are "inactive," that is, they have a trigger_value
== FALSE.
One | of the Standard Return Codes, Standard Return Codes or DDS::Retcode_PreconditionNotMet. |
Implements DDS::Entity.
virtual StatusCondition ^ DDS::DomainParticipant::get_statuscondition | ( | ) | [override, virtual] |
Allows access to the DDS::StatusCondition associated with the DDS::Entity.
The returned condition can then be added to a DDS::WaitSet so that the application can wait for specific status changes that affect the DDS::Entity.
Implements DDS::Entity.
virtual StatusMask DDS::DomainParticipant::get_status_changes | ( | ) | [override, virtual] |
Retrieves the list of communication statuses in the DDS::Entity that are triggered.
That is, the list of statuses whose value has changed since the last time the application read the status using the get_*_status() method.
When the entity is first created or if the entity is not enabled, all communication statuses are in the "untriggered" state so the list returned by the get_status_changes operation will be empty.
The list of statuses returned by the get_status_changes operation refers to the status that are triggered on the Entity itself and does not include statuses that apply to contained entities.
Implements DDS::Entity.
virtual InstanceHandle_t DDS::DomainParticipant::get_instance_handle | ( | ) | [override, virtual] |
Allows access to the DDS::InstanceHandle_t associated with the DDS::Entity.
This operation returns the DDS::InstanceHandle_t that represents the DDS::Entity.
Implements DDS::Entity.