DDS::DomainParticipant entity and associated elements More...

Classes
struct	DDS::DomainParticipantProtocolStatus
	<<extension>> The status of a participant's protocol related metrics, like the number of corrupted messages, change in corrupted messages and timestamp of the last corrupted message. More...

class	DDS::DomainParticipantQos
	QoS policies supported by a DDS::DomainParticipant entity. More...

class	DDS::DomainParticipantListener
	<<interface>> Listener for participant status. More...

class	DDS::DomainParticipant
	<<interface>> Container for all DDS::DomainEntity objects. More...

Functions
bool	DDS::DomainParticipantQos::equals (DomainParticipantQos^ other)
	Compares two DDS::DomainParticipantQos for equality. More...

Properties
static PublisherQos^	DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT `[get]`
	Special value for creating a DDS::Publisher with default QoS. More...

static SubscriberQos^	DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT `[get]`
	Special value for creating a DDS::Subscriber with default QoS. More...

static TopicQos^	DDS::DomainParticipant::TOPIC_QOS_DEFAULT `[get]`
	Special value for creating a DDS::Topic with default QoS. More...

static TopicQos^	DDS::DomainParticipant::TOPIC_QOS_PRINT_ALL `[get]`
	Special value which can be supplied to DDS::TopicQos::ToString(DDS::TopicQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...

static PublisherQos^	DDS::DomainParticipant::PUBLISHER_QOS_PRINT_ALL `[get]`
	Special value which can be supplied to DDS::PublisherQos::ToString(DDS::PublisherQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...

static SubscriberQos^	DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL `[get]`
	Special value which can be supplied to DDS::SubscriberQos::ToString(DDS::SubscriberQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...

static DomainParticipantQos^	DDS::DomainParticipant::DOMAINPARTICIPANT_QOS_PRINT_ALL `[get]`
	Special value which can be supplied to DDS::DomainParticipantQos::ToString(DDS::DomainParticipantQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...

static DomainParticipantFactoryQos^	DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL `[get]`
	Special value which can be supplied to DDS::DomainParticipantFactoryQos::ToString(DDS::DomainParticipantFactoryQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed. More...

static FlowControllerProperty_t^	DDS::DomainParticipant::FLOW_CONTROLLER_PROPERTY_DEFAULT `[get]`
	<<extension>> Special value for creating a DDS::FlowController with default property. More...

static System::String^	DDS::DomainParticipant::SQLFILTER_NAME `[get]`
	<<extension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. More...

static System::String^	DDS::DomainParticipant::STRINGMATCHFILTER_NAME `[get]`
	<<extension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters. More...

Detailed Description

DDS::DomainParticipant entity and associated elements

Function Documentation

◆ equals()

bool DDS::DomainParticipantQos::equals ( DomainParticipantQos^ other )

Compares two DDS::DomainParticipantQos for equality.

Parameters

other <<in>> The other DomainParticipantQos to be compared with this DomainParticipantQos.

Returns: true if the two Qos objects are equal or false otherwise.

Properties

◆ PUBLISHER_QOS_DEFAULT

PublisherQos^ DDS::DomainParticipant::PUBLISHER_QOS_DEFAULT

staticget

Special value for creating a DDS::Publisher with default QoS.

When used in DDS::DomainParticipant::create_publisher, this special value is used to indicate that the DDS::Publisher should be created with the default DDS::Publisher QoS by means of the operation get_default_publisher_qos and using the resulting QoS to create the DDS::Publisher.

When used in DDS::DomainParticipant::set_default_publisher_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDS::DomainParticipant::set_default_publisher_qos operation had never been called.

When used in DDS::Publisher::set_qos, this special value is used to indicate that the QoS of the DDS::Publisher should be changed to match the current default QoS set in the DDS::DomainParticipant that the DDS::Publisher belongs to.

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Publisher; for this purpose, use DDS::DomainParticipant::get_default_publisher_qos.

See also: DDS::DomainParticipant::create_publisher; DDS::DomainParticipant::set_default_publisher_qos; DDS::Publisher::set_qos

Examples:: HelloWorld_publisher.cpp, and HelloWorld_publisher.cs.

◆ SUBSCRIBER_QOS_DEFAULT

SubscriberQos^ DDS::DomainParticipant::SUBSCRIBER_QOS_DEFAULT

staticget

Special value for creating a DDS::Subscriber with default QoS.

When used in DDS::DomainParticipant::create_subscriber, this special value is used to indicate that the DDS::Subscriber should be created with the default DDS::Subscriber QoS by means of the operation get_default_subscriber_qos and using the resulting QoS to create the DDS::Subscriber.

When used in DDS::DomainParticipant::set_default_subscriber_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDS::DomainParticipant::set_default_subscriber_qos operation had never been called.

When used in DDS::Subscriber::set_qos, this special value is used to indicate that the QoS of the DDS::Subscriber should be changed to match the current default QoS set in the DDS::DomainParticipant that the DDS::Subscriber belongs to.

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Subscriber; for this purpose, use DDS::DomainParticipant::get_default_subscriber_qos.

See also: DDS::DomainParticipant::create_subscriber; DDS::DomainParticipant::get_default_subscriber_qos; DDS::Subscriber::set_qos

Examples:: HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

◆ TOPIC_QOS_DEFAULT

TopicQos^ DDS::DomainParticipant::TOPIC_QOS_DEFAULT

staticget

Special value for creating a DDS::Topic with default QoS.

When used in DDS::DomainParticipant::create_topic, this special value is used to indicate that the DDS::Topic should be created with the default DDS::Topic QoS by means of the operation get_default_topic_qos and using the resulting QoS to create the DDS::Topic.

When used in DDS::DomainParticipant::set_default_topic_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDS::DomainParticipant::set_default_topic_qos operation had never been called.

When used in DDS::Topic::set_qos, this special value is used to indicate that the QoS of the DDS::Topic should be changed to match the current default QoS set in the DDS::DomainParticipant that the DDS::Topic belongs to.

Warning: This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a Topic; for this purpose, use DDS::DomainParticipant::get_default_topic_qos.

See also: DDS::DomainParticipant::create_topic; DDS::DomainParticipant::set_default_topic_qos; DDS::Topic::set_qos

Examples:: HelloWorld_publisher.cpp, HelloWorld_publisher.cs, HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

◆ TOPIC_QOS_PRINT_ALL

TopicQos^ DDS::DomainParticipant::TOPIC_QOS_PRINT_ALL

staticget

Special value which can be supplied to DDS::TopicQos::ToString(DDS::TopicQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::TopicQos::ToString(DDS::TopicQos^ baseQos, DDS::QosPrintFormat^ format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS::DomainParticipant::TOPIC_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when DDS::DomainParticipant::TOPIC_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::TopicQos::ToString(DDS::TopicQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ PUBLISHER_QOS_PRINT_ALL

PublisherQos^ DDS::DomainParticipant::PUBLISHER_QOS_PRINT_ALL

staticget

Special value which can be supplied to DDS::PublisherQos::ToString(DDS::PublisherQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::PublisherQos::ToString(DDS::PublisherQos^ baseQos, DDS::QosPrintFormat^ format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS::DomainParticipant::PUBLISHER_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when DDS::DomainParticipant::PUBLISHER_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::PublisherQos::ToString(DDS::PublisherQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ SUBSCRIBER_QOS_PRINT_ALL

SubscriberQos^ DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL

staticget

Special value which can be supplied to DDS::SubscriberQos::ToString(DDS::SubscriberQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::SubscriberQos::ToString(DDS::SubscriberQos^ baseQos, DDS::QosPrintFormat^ format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::SubscriberQos::ToString(DDS::SubscriberQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ DOMAINPARTICIPANT_QOS_PRINT_ALL

DomainParticipantQos^ DDS::DomainParticipant::DOMAINPARTICIPANT_QOS_PRINT_ALL

staticget

Special value which can be supplied to DDS::DomainParticipantQos::ToString(DDS::DomainParticipantQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::DomainParticipantQos::ToString(DDS::DomainParticipantQos^ baseQos, DDS::QosPrintFormat^ format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS::DomainParticipant::DOMAINPARTICIPANT_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when DDS::DomainParticipant::DOMAINPARTICIPANT_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::DomainParticipantQos::ToString(DDS::DomainParticipantQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

DomainParticipantFactoryQos^ DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

staticget

Special value which can be supplied to DDS::DomainParticipantFactoryQos::ToString(DDS::DomainParticipantFactoryQos^ baseQos, DDS::QosPrintFormat^ format) indicating that all of the QoS should be printed.

The DDS::DomainParticipantFactoryQos::ToString(DDS::DomainParticipantFactoryQos^ baseQos, DDS::QosPrintFormat^ format) API accepts a base QoS profile as one of its arguments. The resultant string only contains the differences with respect to the supplied base QoS profile. Supplying the DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL sentinel value as the base QoS will result in all of the QoS being printed.

Note that there are some QoS policies and fields which are not intended for public use. Even when DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL is supplied as the base, these will not be printed unless they differ from the documented default. If you want to see their values, you must use the print_private field within the DDS::QosPrintFormat structure.

This value should only be used as the base parameter to the DDS::DomainParticipantFactoryQos::ToString(DDS::DomainParticipantFactoryQos^ baseQos, DDS::QosPrintFormat^ format) API.

◆ FLOW_CONTROLLER_PROPERTY_DEFAULT

FlowControllerProperty_t^ DDS::DomainParticipant::FLOW_CONTROLLER_PROPERTY_DEFAULT

staticget

<<extension>> Special value for creating a DDS::FlowController with default property.

When used in DDS::DomainParticipant::create_flowcontroller, this special value is used to indicate that the DDS::FlowController should be created with the default DDS::FlowController property by means of the operation get_default_flowcontroller_property and using the resulting QoS to create the DDS::FlowControllerProperty_t.

When used in DDS::DomainParticipant::set_default_flowcontroller_property, this special value indicates that the default QoS should be reset back to the initial value that would be used if the DDS::DomainParticipant::set_default_flowcontroller_property operation had never been called.

When used in DDS::FlowController::set_property, this special value is used to indicate that the property of the DDS::FlowController should be changed to match the current default property set in the DDS::DomainParticipant that the DDS::FlowController belongs to.

Warning: This value is a constant and should never be modified. You cannot use this value to get the default properties for a FlowController; for this purpose, use DDS::DomainParticipant::get_default_flowcontroller_property.

See also: DDS::DomainParticipant::create_flowcontroller; DDS::DomainParticipant::set_default_flowcontroller_property; DDS::FlowController::set_property

◆ SQLFILTER_NAME

System:: String^ DDS::DomainParticipant::SQLFILTER_NAME

staticget

<<extension>> The name of the built-in SQL filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

See also: Queries and Filters Syntax

◆ STRINGMATCHFILTER_NAME

System:: String^ DDS::DomainParticipant::STRINGMATCHFILTER_NAME

staticget

<<extension>> The name of the built-in StringMatch filter that can be used with ContentFilteredTopics and MultiChannel DataWriters.

The StringMatch Filter is a subset of the SQL filter; it only supports the MATCH relational operator on a single string field.

See also: Queries and Filters Syntax

Classes

Functions

Properties

Detailed Description

Function Documentation

◆ equals()

Properties

◆ PUBLISHER_QOS_DEFAULT

◆ SUBSCRIBER_QOS_DEFAULT

◆ TOPIC_QOS_DEFAULT

◆ TOPIC_QOS_PRINT_ALL

◆ PUBLISHER_QOS_PRINT_ALL

◆ SUBSCRIBER_QOS_PRINT_ALL

◆ DOMAINPARTICIPANT_QOS_PRINT_ALL

◆ DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL

◆ FLOW_CONTROLLER_PROPERTY_DEFAULT

◆ SQLFILTER_NAME

◆ STRINGMATCHFILTER_NAME