DDS::SubscriberQos Class Reference

QoS policies supported by a DDS::Subscriber entity. More...

#include <managed_subscription.h>

Public Member Functions
bool	equals (SubscriberQos^ other)
	Compares two DDS::SubscriberQos for equality. More...
virtual System::String ^	ToString () override
	Overrides the builtin ToString method. More...
System::String ^	ToString (SubscriberQos^ base, QosPrintFormat^ format)
	Obtains a string representation of a SubscriberQos object. More...
System::String ^	ToString (QosPrintFormat^ format)
	Obtains a string representation of a SubscriberQos object. More...
System::String ^	ToString (SubscriberQos^ base)
	Obtains a string representation of a SubscriberQos object. More...

Public Attributes
PresentationQosPolicy	presentation
	Presentation policy, PRESENTATION. More...
PartitionQosPolicy ^	partition
	Partition policy, PARTITION. More...
GroupDataQosPolicy ^	group_data
	Group data policy, GROUP_DATA. More...
EntityFactoryQosPolicy	entity_factory
	Entity factory policy, ENTITY_FACTORY. More...
ExclusiveAreaQosPolicy	exclusive_area
	<<extension>> Exclusive area for the subscriber and all entities that are created by the subscriber. More...
EntityNameQosPolicy ^	subscriber_name
	<<extension>> EntityName policy, ENTITY_NAME. More...

Detailed Description

QoS policies supported by a DDS::Subscriber entity.

You must set certain members in a consistent manner:

length of DDS::GroupDataQosPolicy::value <= DDS::DomainParticipantResourceLimitsQosPolicy::subscriber_group_data_max_length

length of DDS::PartitionQosPolicy::name <= DDS::DomainParticipantResourceLimitsQosPolicy::max_partitions

combined number of characters (including terminating 0) in DDS::PartitionQosPolicy::name <= DDS::DomainParticipantResourceLimitsQosPolicy::max_partition_cumulative_characters

If any of the above are not true, DDS::Subscriber::set_qos and DDS::Subscriber::set_qos_with_profile will fail with DDS::Retcode_InconsistentPolicy

Member Function Documentation

ToString() [1/4]

virtual System::String ^ DDS::SubscriberQos::ToString ( )

overridevirtual

Overrides the builtin ToString method.

The various ToString() overloads allow formatting the output and printing only the differences with respect to another SubscriberQos object.

SubscriberQos qos = new SubscriberQos();
String theString = new String();

// The most basic version of the API simply overrides the builtin
// ToString method. Only the differences with respect to the
// documented default are printed to the string. The string is formatted
// according to the default values for QosPrintFormat.
theString = qos.ToString();

// This overload allows us to specify a base profile. Only the differences
// with respect to this base profile are printed to the string. If the two
// Qos objects are equal, the resultant string will be empty.
SubscriberQos base = new SubscriberQos();
theString = qos.toString(base);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat();
theString = qos.ToString(base, format);

// The sentinel value SUBSCRIBER_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.ToString(SUBSCRIBER_QOS_PRINT_ALL);

This overload uses the default print format and only prints the differences between the supplied SubscriberQos and the documented default.

Returns

The string representation of the Qos.

ToString() [2/4]

System::String ^ DDS::SubscriberQos::ToString	(	SubscriberQos^	base,
		QosPrintFormat^	format
	)

Obtains a string representation of a SubscriberQos object.

Parameters

format	The print format used to format the output.
base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns

The string representation of the Qos.

ToString() [3/4]

System::String ^ DDS::SubscriberQos::ToString

(

QosPrintFormat^

format

)

Obtains a string representation of a SubscriberQos object.

Parameters

format

The print format used to format the output.

This overload prints the differences between the qos and the documented. default. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns

The string representation of the Qos.

ToString() [4/4]

System::String ^ DDS::SubscriberQos::ToString

(

SubscriberQos^

base

)

Obtains a string representation of a SubscriberQos object.

Parameters

base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::DomainParticipant::SUBSCRIBER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the default value for DDS::QosPrintFormat.

Returns

The string representation of the Qos.

Member Data Documentation

presentation

PresentationQosPolicy DDS::SubscriberQos::presentation

Presentation policy, PRESENTATION.

partition

PartitionQosPolicy ^ DDS::SubscriberQos::partition

Partition policy, PARTITION.

group_data

GroupDataQosPolicy ^ DDS::SubscriberQos::group_data

Group data policy, GROUP_DATA.

entity_factory

EntityFactoryQosPolicy DDS::SubscriberQos::entity_factory

Entity factory policy, ENTITY_FACTORY.

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

exclusive_area

ExclusiveAreaQosPolicy DDS::SubscriberQos::exclusive_area

<<extension>> Exclusive area for the subscriber and all entities that are created by the subscriber.

subscriber_name

EntityNameQosPolicy ^ DDS::SubscriberQos::subscriber_name

<<extension>> EntityName policy, ENTITY_NAME.