DDS::TopicQos Class Reference

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

#include <managed_topic.h>

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

Public Attributes
TopicDataQosPolicy ^	topic_data
	Topic data policy, TOPIC_DATA. More...
DurabilityQosPolicy	durability
	Durability policy, DURABILITY. More...
DurabilityServiceQosPolicy	durability_service
	DurabilityService policy, DURABILITY_SERVICE. More...
DeadlineQosPolicy	deadline
	Deadline policy, DEADLINE. More...
LatencyBudgetQosPolicy	latency_budget
	Latency budget policy, LATENCY_BUDGET. More...
LivelinessQosPolicy	liveliness
	Liveliness policy, LIVELINESS. More...
ReliabilityQosPolicy	reliability
	Reliability policy, RELIABILITY. More...
DestinationOrderQosPolicy	destination_order
	Destination order policy, DESTINATION_ORDER. More...
HistoryQosPolicy	history
	History policy, HISTORY. More...
ResourceLimitsQosPolicy	resource_limits
	Resource limits policy, RESOURCE_LIMITS. More...
TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY. More...
LifespanQosPolicy	lifespan
	Lifespan policy, LIFESPAN. More...
OwnershipQosPolicy	ownership
	Ownership policy, OWNERSHIP. More...
DataRepresentationQosPolicy ^	representation
	Data representation policy, DATA_REPRESENTATION. More...

Detailed Description

QoS policies supported by a DDS::Topic entity.

You must set certain members in a consistent manner:

length of DDS::TopicQos::topic_data .value <= DDS::DomainParticipantQos::resource_limits .topic_data_max_length

If any of the above are not true, DDS::Topic::set_qos, DDS::Topic::set_qos_with_profile and DDS::DomainParticipant::set_default_topic_qos will fail with DDS::Retcode_InconsistentPolicy and DDS::DomainParticipant::create_topic will return NULL.

Entity:

DDS::Topic

See also

QoS Policies allowed ranges within each Qos.

Member Function Documentation

ToString() [1/4]

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

overridevirtual

Overrides the builtin ToString method.

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

TopicQos qos = new TopicQos();
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.
TopicQos base = new TopicQos();
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 TOPIC_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.ToString(TOPIC_QOS_PRINT_ALL);

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

Returns

The string representation of the Qos.

ToString() [2/4]

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

Obtains a string representation of a TopicQos 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::TOPIC_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::TopicQos::ToString

(

QosPrintFormat^

format

)

Obtains a string representation of a TopicQos 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::TopicQos::ToString

(

TopicQos^

base

)

Obtains a string representation of a TopicQos 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::TOPIC_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

topic_data

TopicDataQosPolicy ^ DDS::TopicQos::topic_data

Topic data policy, TOPIC_DATA.

durability

DurabilityQosPolicy DDS::TopicQos::durability

Durability policy, DURABILITY.

durability_service

DurabilityServiceQosPolicy DDS::TopicQos::durability_service

DurabilityService policy, DURABILITY_SERVICE.

deadline

DeadlineQosPolicy DDS::TopicQos::deadline

Deadline policy, DEADLINE.

latency_budget

LatencyBudgetQosPolicy DDS::TopicQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

liveliness

LivelinessQosPolicy DDS::TopicQos::liveliness

Liveliness policy, LIVELINESS.

reliability

ReliabilityQosPolicy DDS::TopicQos::reliability

Reliability policy, RELIABILITY.

destination_order

DestinationOrderQosPolicy DDS::TopicQos::destination_order

Destination order policy, DESTINATION_ORDER.

history

HistoryQosPolicy DDS::TopicQos::history

History policy, HISTORY.

resource_limits

ResourceLimitsQosPolicy DDS::TopicQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

transport_priority

TransportPriorityQosPolicy DDS::TopicQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

lifespan

LifespanQosPolicy DDS::TopicQos::lifespan

Lifespan policy, LIFESPAN.

ownership

OwnershipQosPolicy DDS::TopicQos::ownership

Ownership policy, OWNERSHIP.

representation

DataRepresentationQosPolicy ^ DDS::TopicQos::representation

Data representation policy, DATA_REPRESENTATION.