DDS_PresentationQosPolicy Struct Reference
[PRESENTATION]

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

List of all members.

Public Attributes

DDS_PresentationQosPolicyAccessScopeKind access_scope

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

DDS_Boolean coherent_access

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

DDS_Boolean ordered_access

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

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:: DDSPublisher, DDSSubscriber

Status:: DDS_OFFERED_INCOMPATIBLE_QOS_STATUS, DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS

Properties:: RxO = YES
Changeable = UNTIL ENABLE

Usage

A DDSDataReader will usually receive data in the order that it was sent by a DDSDataWriter, and the data is presented to the DDSDataReader as soon as the application receives the next expected value. However, sometimes, you may want a set of data for the same topic to be presented to the DDSDataReader 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 topic, across instances of a single topic, and even across multiple topics 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 DDSPublisher::begin_coherent_changes and DDSPublisher::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_INSTANCE_PRESENTATION_QOS (the default), the use of DDSPublisher::begin_coherent_changes and DDSPublisher::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_TOPIC_PRESENTATION_QOS, then coherent changes (indicated by their enclosure within calls to DDSPublisher::begin_coherent_changes and DDSPublisher::end_coherent_changes) will be made available as such to each remote DDSDataReader independently. That is, changes made to instances within each individual DDSDataWriter will be available as coherent with respect to other changes to instances in that same DDSDataWriter, but will not be grouped with changes made to instances belonging to a different DDSDataWriter.

If access_scope is set to DDS_GROUP_PRESENTATION_QOS, then coherent changes made to instances through a DDSDataWriter attached to a common DDSPublisher 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_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 DDSDataWriter.

If access_scope is set to DDS_TOPIC_PRESENTATION_QOS, changes (creations, deletions, modifications) made by a single DDSDataWriter are made available to subscribers in the same order they occur. Changes made to instances though different DDSDataWriter 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 DDSDataWriter objects attached to the same DDSPublisher.

Finally, if access_scope is set to DDS_GROUP_PRESENTATION_QOS, changes made to instances via DDSDataWriter entities attached to the same DDSPublisher 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 DDSSubscriber 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 DDSDataReader objects.

For DDS_GROUP_PRESENTATION_QOS the subscribing application must use the APIs DDSSubscriber::begin_access, DDSSubscriber::end_access and DDSSubscriber::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_HIGHEST_OFFERED_PRESENTATION_QOS. For the purposes of this inequality, the values of access_scope are considered ordered such that DDS_INSTANCE_PRESENTATION_QOS < DDS_TOPIC_PRESENTATION_QOS < DDS_GROUP_PRESENTATION_QOS.
requested coherent_access is DDS_BOOLEAN_FALSE, or else both offered and requested coherent_access are DDS_BOOLEAN_TRUE.
requested ordered_access is DDS_BOOLEAN_FALSE, or else both offered and requested ordered_access are DDS_BOOLEAN_TRUE.

Member Data Documentation

DDS_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_INSTANCE_PRESENTATION_QOS

DDS_Boolean DDS_PresentationQosPolicy::coherent_access

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.

[default] DDS_BOOLEAN_FALSE

DDS_Boolean DDS_PresentationQosPolicy::ordered_access

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.