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

#include <managed_domain.h>

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

virtual System::String ^	ToString () override
	Overrides the builtin ToString method. More...

System::String ^	ToString (DomainParticipantQos^ base, QosPrintFormat^ format)
	Obtains a string representation of a DomainParticipantQos object. More...

System::String ^	ToString (QosPrintFormat^ format)
	Obtains a string representation of a DomainParticipantQos object. More...

System::String ^	ToString (DomainParticipantQos^ base)
	Obtains a string representation of a DomainParticipantQos object. More...

Public Attributes
UserDataQosPolicy ^	user_data
	User data policy, USER_DATA. More...

EntityFactoryQosPolicy	entity_factory
	Entity factory policy, ENTITY_FACTORY. More...

WireProtocolQosPolicy	wire_protocol
	<<extension>> Wire Protocol policy, WIRE_PROTOCOL. More...

TransportBuiltinQosPolicy	transport_builtin
	<<extension>> Transport Builtin policy, TRANSPORT_BUILTIN. More...

TransportUnicastQosPolicy ^	default_unicast
	<<extension>> Default Unicast Transport policy, TRANSPORT_UNICAST. More...

DiscoveryQosPolicy ^	discovery
	<<extension>> Discovery policy, DISCOVERY. More...

DomainParticipantResourceLimitsQosPolicy	resource_limits
	<<extension>> Domain participant resource limits policy, DOMAIN_PARTICIPANT_RESOURCE_LIMITS. More...

EventQosPolicy ^	event_qos
	<<extension>> Event policy, EVENT. More...

ReceiverPoolQosPolicy ^	receiver_pool
	<<extension>> Receiver pool policy, RECEIVER_POOL. More...

DatabaseQosPolicy ^	database
	<<extension>> Database policy, DATABASE. More...

DiscoveryConfigQosPolicy ^	discovery_config
	<<extension>> Discovery config policy, DISCOVERY_CONFIG. More...

PropertyQosPolicy ^	property_qos
	<<extension>> Property policy, PROPERTY. More...

EntityNameQosPolicy ^	participant_name
	<<extension>> The participant name. ENTITY_NAME More...

TransportMulticastMappingQosPolicy ^	multicast_mapping
	<<extension>> The multicast mapping policy. TRANSPORT_MULTICAST_MAPPING More...

ServiceQosPolicy	service
	<<extension>> The service qos policy. SERVICE More...

TypeSupportQosPolicy	type_support
	<<extension>> Type support data, TYPESUPPORT. More...

Detailed Description

QoS policies supported by a DDS::DomainParticipant entity.

Certain members must be set in a consistent manner:

Length of DDS::DomainParticipantQos::user_data .value <= DDS::DomainParticipantQos::resource_limits .participant_user_data_max_length

For DDS::DomainParticipantQos::discovery_config .publication_writer
high_watermark <= DDS::DomainParticipantQos::resource_limits .local_writer_allocation .max_count heartbeats_per_max_samples <= DDS::DomainParticipantQos::resource_limits .local_writer_allocation.max_count

For DDS::DomainParticipantQos::discovery_config .suscription_writer
high_watermark <= DDS::DomainParticipantQos::resource_limits .local_reader_allocation.max_count heartbeats_per_max_samples <= DDS::DomainParticipantQos::resource_limits .local_reader_allocation.max_count

If any of the above are not true, DDS::DomainParticipant::set_qos and DDS::DomainParticipant::set_qos_with_profile and DDS::DomainParticipantFactory::set_default_participant_qos will fail with DDS::Retcode_InconsistentPolicy, and DDS::DomainParticipantFactory::create_participant will fail.

Entity:: DDS::DomainParticipant

See also: QoS Policies and allowed ranges within each Qos.; NDDS_DISCOVERY_PEERS

Member Function Documentation

◆ ToString() [1/4]

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

overridevirtual

Overrides the builtin ToString method.

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

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

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

Returns: The string representation of the Qos.

◆ ToString() [2/4]

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

Obtains a string representation of a DomainParticipantQos 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::DOMAINPARTICIPANT_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::DomainParticipantQos::ToString ( QosPrintFormat^ format )

Obtains a string representation of a DomainParticipantQos 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::DomainParticipantQos::ToString ( DomainParticipantQos^ base )

Obtains a string representation of a DomainParticipantQos 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::DOMAINPARTICIPANT_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.