RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.Presentation Class Reference

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

Inherits IEquatable< Presentation >.

Public Member Functions

Presentation With (Action< PresentationBuilder > build)
 Creates a new Presentation with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (Presentation other)
 Compares for equality More...
 

Properties

PresentationAccessScopeKind AccessScope [get]
 Determines the largest scope spanning the entities for which the order and coherency of changes can be preserved. More...
 
bool CoherentAccess [get]
 Specifies support for coherent access. Controls whether coherent access is supported within the scope access_scope. More...
 
bool OrderedAccess [get]
 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...
 
bool DropIncompleteCoherentSet [get]
 Indicates whether or not a Subscription.DataReader<T> should lose samples from an incomplete coherent set (one for which not all the samples were received). Such samples are reported as lost in the SAMPLE_LOST Status. More...
 
static Presentation Default [get]
 Singleton containing the default value of a Presentation More...
 

Detailed Description

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

The full documentation is available in the C API: DDS_PresentationQosPolicy

Member Function Documentation

◆ With()

Presentation Rti.Dds.Core.Policy.Presentation.With ( Action< PresentationBuilder build)
inline

Creates a new Presentation with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this Presentation.
Returns
A new Presentation with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.Presentation.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.Presentation.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.Presentation.Equals ( Presentation  other)
inline

Compares for equality

Property Documentation

◆ AccessScope

PresentationAccessScopeKind Rti.Dds.Core.Policy.Presentation.AccessScope
get

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

The full documentation is available in the C API: DDS_PresentationQosPolicy_access_scope

◆ CoherentAccess

bool Rti.Dds.Core.Policy.Presentation.CoherentAccess
get

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

The full documentation is available in the C API: DDS_PresentationQosPolicy_coherent_access

◆ OrderedAccess

bool Rti.Dds.Core.Policy.Presentation.OrderedAccess
get

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

The full documentation is available in the C API: DDS_PresentationQosPolicy_ordered_access

◆ DropIncompleteCoherentSet

bool Rti.Dds.Core.Policy.Presentation.DropIncompleteCoherentSet
get

Indicates whether or not a Subscription.DataReader<T> should lose samples from an incomplete coherent set (one for which not all the samples were received). Such samples are reported as lost in the SAMPLE_LOST Status.

The full documentation is available in the C API: DDS_PresentationQosPolicy_drop_incomplete_coherent_set

◆ Default

Presentation Rti.Dds.Core.Policy.Presentation.Default
staticget

Singleton containing the default value of a Presentation