Specifies how the samples representing changes to data instances are presented to a subscribing application. More...

#include <managed_infrastructure.h>

Static Public Member Functions
static System::String ^	get_presentation_qos_policy_name ()
	Stringified human-readable name for DDS::PresentationQosPolicy. More...

Public Attributes
PresentationQosPolicyAccessScopeKind	access_scope
	Determines the largest scope spanning the entities for which the order and coherency of changes can be preserved. More...

Properties
System::Boolean	coherent_access `[get, set]`
	Specifies support for coherent access. Controls whether coherent access is supported within the scope `access_scope`. More...

System::Boolean	ordered_access `[get, set]`
	Specifies support for ordered access to the samples received at the subscription end. Controls whether ordered access is supported within the scope `access_scope`. More...

Detailed Description

Specifies how the samples representing changes to data instances are presented to a subscribing application.

This QoS policy controls the extent to which changes to data instances can be made dependent on each other and also the kind of dependencies that can be propagated and maintained by RTI Connext. Specifically, this policy affects the application's ability to:

specify and receive coherent changes to instances
specify the relative order in which changes are presented

Entity:: DDS::Publisher, DDS::Subscriber

Status:: DDS::StatusKind::OFFERED_INCOMPATIBLE_QOS_STATUS, DDS::StatusKind::REQUESTED_INCOMPATIBLE_QOS_STATUS

Properties:: RxO = YES
Changeable = UNTIL ENABLE

Usage

A DDS::DataReader will usually receive data in the order that it was sent by a DDS::DataWriter, and the data is presented to the DDS::DataReader as soon as the application receives the next expected value. However, sometimes, you may want a set of data for the same DDS::DataWriter to be presented to the DDS::DataReader only after all of the elements of the set have been received. Or you may want the data to be presented in a different order than that in which it was received. Specifically for keyed data, you may want the middleware to present the data in keyed – or instance – order, such that samples pertaining to the same instance are presented together.

The Presentation QoS policy allows you to specify different scopes of presentation: within a DDS::DataWriter, across instances of a single DDS::DataWriter, and even across multiple DataWriters used by different writers of a publisher. It also controls whether or not a set of changes within the scope is delivered at the same time or can be delivered as soon as each element is received.

coherent_access controls whether RTI Connext will preserve the groupings of changes made by a publishing application by means of the operations DDS::Publisher::begin_coherent_changes and DDS::Publisher::end_coherent_changes.

ordered_access controls whether RTI Connext will preserve the order of changes.

access_scope controls the granularity of the other settings. See below:

If coherent_access is set, then the access_scope controls the maximum extent of coherent changes. The behavior is as follows:

If access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::INSTANCE_PRESENTATION_QOS (the default), the use of DDS::Publisher::begin_coherent_changes and DDS::Publisher::end_coherent_changes has no effect on how the subscriber can access the data, because with the scope limited to each instance, changes to separate instances are considered independent and thus cannot be grouped into a coherent set.

If access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::TOPIC_PRESENTATION_QOS, then coherent changes (indicated by their enclosure within calls to DDS::Publisher::begin_coherent_changes and DDS::Publisher::end_coherent_changes) will be made available as such to each remote DDS::DataReader independently. That is, changes made to instances within each individual DDS::DataWriter will be available as coherent with respect to other changes to instances in that same DDS::DataWriter, but will not be grouped with changes made to instances belonging to a different DDS::DataWriter.

If access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::GROUP_PRESENTATION_QOS, then coherent changes made to instances through a DDS::DataWriter attached to a common DDS::Publisher are made available as a unit to remote subscribers. (RTI does not currently support this access scope.)

If ordered_access is set, then the access_scope controls the maximum extent for which order will be preserved by RTI Connext.

If access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::INSTANCE_PRESENTATION_QOS (the lowest level), then changes to each instance are considered unordered relative to changes to any other instance. That means that changes (creations, deletions, modifications) made to two instances are not necessarily seen in the order they occur. This is the case even if it is the same application thread making the changes using the same DDS::DataWriter.

If access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::TOPIC_PRESENTATION_QOS, changes (creations, deletions, modifications) made by a single DDS::DataWriter are made available to subscribers in the same order they occur. Changes made to instances though different DDS::DataWriter entities are not necessarily seen in the order they occur. This is the case, even if the changes are made by a single application thread using DDS::DataWriter objects attached to the same DDS::Publisher.

Finally, if access_scope is set to DDS::PresentationQosPolicyAccessScopeKind::GROUP_PRESENTATION_QOS, changes made to instances via DDS::DataWriter entities attached to the same DDS::Publisher object are made available to subscribers on the same order they occur.

Note that this QoS policy controls the scope at which related changes are made available to the subscriber. This means the subscriber can access the changes in a coherent manner and in the proper order; however, it does not necessarily imply that the DDS::Subscriber will indeed access the changes in the correct order. For that to occur, the application at the subscriber end must use the proper logic in reading the DDS::DataReader objects.

For DDS::PresentationQosPolicyAccessScopeKind::GROUP_PRESENTATION_QOS the subscribing application must use the APIs DDS::Subscriber::begin_access, DDS::Subscriber::end_access and DDS::Subscriber::get_datareaders to access the changes in the proper order.

Compatibility

The value offered is considered compatible with the value requested if and only if the following conditions are met:

the inequality offered access_scope >= requested access_scope evaluates to 'TRUE' or requested access_scope is DDS::PresentationQosPolicyAccessScopeKind::HIGHEST_OFFERED_PRESENTATION_QOS. For the purposes of this inequality, the values of access_scope are considered ordered such that DDS::PresentationQosPolicyAccessScopeKind::INSTANCE_PRESENTATION_QOS < DDS::PresentationQosPolicyAccessScopeKind::TOPIC_PRESENTATION_QOS < DDS::PresentationQosPolicyAccessScopeKind::GROUP_PRESENTATION_QOS.
requested coherent_access is false, or else both offered and requested coherent_access are true.
requested ordered_access is false, or else both offered and requested ordered_access are true.

Member Data Documentation

◆ access_scope

PresentationQosPolicyAccessScopeKind DDS::PresentationQosPolicy::access_scope

Determines the largest scope spanning the entities for which the order and coherency of changes can be preserved.

[default] DDS::PresentationQosPolicyAccessScopeKind::INSTANCE_PRESENTATION_QOS

Property Documentation

◆ coherent_access

System:: Boolean DDS::PresentationQosPolicy::coherent_access

getset

Specifies support for coherent access. Controls whether coherent access is supported within the scope access_scope.

That is, the ability to group a set of changes as a unit on the publishing end such that they are received as a unit at the subscribing end.

Note: To use this feature, the DataWriter must be configured for RELIABLE communication (see DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS).

[default] false

◆ ordered_access

System:: Boolean DDS::PresentationQosPolicy::ordered_access

getset

Specifies support for ordered access to the samples received at the subscription end. Controls whether ordered access is supported within the scope access_scope.

That is, the ability of the subscriber to see changes in the same order as they occurred on the publishing end.