RTI Connext C# API  6.1.0
Omg.Dds.Subscription Namespace Reference

Classes

class  DataState
 Information about a sample's SampleState, ViewState, and InstanceState. More...
 
class  DataStateOperations
 Extensions for SampleState, ViewState and InstanceState that allow combining them to form a DataState More...
 
struct  GenerationCount
 Keeps track of changes in InstanceState. More...
 
struct  Rank
 Keeps track of the number of samples related to the same instance that follow in a sample collection. More...
 

Enumerations

enum class  SampleState {
  None ,
  Read ,
  NotRead ,
  Any
}
 Indicates whether or not a sample has ever been read. More...
 
enum class  ViewState {
  None ,
  New ,
  NotNew ,
  Any
}
 Indicates whether or not an instance is new. More...
 
enum class  InstanceState {
  None ,
  Alive ,
  NotAliveDisposed ,
  NotAliveNoWriters ,
  NotAlive ,
  Any
}
 Indicates if the samples are from a live DataWriter or not. More...
 

Enumeration Type Documentation

◆ InstanceState

enum InstanceState
strong

Indicates if the samples are from a live DataWriter or not.

The full documentation is available in the C API: DDS_InstanceStateKind

Enumerator
None 

Mask where no flag is selected

Alive 

Indicates that the instance is currently in existence.

NotAliveDisposed 

Indicates that the instance has been disposed by a DataWriter.

NotAliveNoWriters 

Indicates that none of the DataWriters that are currently alive (according to the Liveliness QoS policy) are writing this instance.

NotAlive 

Mask containing the NotAliveDisposed and NotAliveNoWriters flags.

Any 

Mask containing all flags.

◆ SampleState

enum SampleState
strong

Indicates whether or not a sample has ever been read.

The full documentation is available in the C API: DDS_SampleStateKind

Enumerator
None 

Mask where no flag is selected.

Read 

Indicates that the application has already accessed that sample by means of a read or take operation.

NotRead 

Indicates that the application has not accessed that sample before.

Any 

A mask containing all flags.

◆ ViewState

enum ViewState
strong

Indicates whether or not an instance is new.

The full documentation is available in the C API: DDS_ViewStateKind

Enumerator
None 

Mask where no flag is selected

New 

Indicates that the latest generation of an instance has not previously been accessed.

NotNew 

Indicates that the latest generation of an instance has previously been accessed.

Any 

Mask containing all flags