RTI Connext C# API Version 7.2.0
Rti.Dds.Subscription.SampleInfo Class Reference

Information that accompanies each sample received by a DataReader More...

Properties

bool ValidData [get]
 Indicates whether the sample contains data or else it is only used to communicate a change in the instance state (this.State.InstanceState) More...
 
DataState State [get]
 Contains the sample, view and instance states More...
 
GenerationCount GenerationCount [get]
 Keeps track of changes in the InstanceState (State) for a given instance. More...
 
Rank Rank [get]
 Keeps track of the number of samples related to the same instance More...
 
InstanceHandle InstanceHandle [get]
 Identifies locally the corresponding instance. More...
 
InstanceHandle PublicationHandle [get]
 Identifies locally the DataWriter that modified the instance. More...
 
Time SourceTimestamp [get]
 The timestamp when the sample was written by a DataWriter. More...
 
Time ReceptionTimestamp [get]
 The timestamp when the sample was received and added to the DataReader's queue. More...
 
long PublicationSequenceNumber [get]
 The publication sequence number. More...
 
long ReceptionSequenceNumber [get]
 The reception sequence number when sample was committed by a DataReader More...
 
SampleIdentity PublicationVirtualSampleIdentity [get]
 The original publication virtual sample identity. More...
 
SampleIdentity OriginalPublicationVirtualSampleIdentity [get]
 The original publication virtual identity. More...
 
SampleIdentity RelatedOriginalPublicationVirtualSampleIdentity [get]
 The original publication virtual identity of a related sample. More...
 
int Flag [get]
 Flags associated with the sample. More...
 
Guid SourceGuid [get]
 The application logical data source associated with the sample. More...
 
Guid RelatedSourceGuid [get]
 The application logical data source that is related to the sample. More...
 
Guid RelatedSubscriptionGuid [get]
 The related_reader_guid associated with the sample. More...
 
Guid TopicQueryGuid [get]
 The Guid of the TopicQuery that is related to the sample. More...
 
CoherentSetInfo CoherentSetInfo [get]
 If this sample belongs to a coherent set, this property contains information about the coherent set. More...
 

Detailed Description

Information that accompanies each sample received by a DataReader

The full documentation is available in the C API: DDS_SampleInfo

Property Documentation

◆ ValidData

bool Rti.Dds.Subscription.SampleInfo.ValidData
get

Indicates whether the sample contains data or else it is only used to communicate a change in the instance state (this.State.InstanceState)

The full documentation is available in the C API: DDS_SampleInfo_valid_data

◆ State

DataState Rti.Dds.Subscription.SampleInfo.State
get

Contains the sample, view and instance states

◆ GenerationCount

GenerationCount Rti.Dds.Subscription.SampleInfo.GenerationCount
get

Keeps track of changes in the InstanceState (State) for a given instance.

The full documentation is available in the C API: DDS_SampleInfo_disposed_generation_count

◆ Rank

Rank Rti.Dds.Subscription.SampleInfo.Rank
get

Keeps track of the number of samples related to the same instance

that follow in a LoanedSamples<T> collection.

The full documentation is available in the C API: DDS_SampleInfo_sample_rank

◆ InstanceHandle

InstanceHandle Rti.Dds.Subscription.SampleInfo.InstanceHandle
get

Identifies locally the corresponding instance.

The full documentation is available in the C API: DDS_SampleInfo_instance_handle

◆ PublicationHandle

InstanceHandle Rti.Dds.Subscription.SampleInfo.PublicationHandle
get

Identifies locally the DataWriter that modified the instance.

The full documentation is available in the C API: DDS_SampleInfo_publication_handle

◆ SourceTimestamp

Time Rti.Dds.Subscription.SampleInfo.SourceTimestamp
get

The timestamp when the sample was written by a DataWriter.

The full documentation is available in the C API: DDS_SampleInfo_source_timestamp

◆ ReceptionTimestamp

Time Rti.Dds.Subscription.SampleInfo.ReceptionTimestamp
get

The timestamp when the sample was received and added to the DataReader's queue.

The full documentation is available in the C API: DDS_SampleInfo_reception_timestamp

◆ PublicationSequenceNumber

long Rti.Dds.Subscription.SampleInfo.PublicationSequenceNumber
get

The publication sequence number.

The full documentation is available in the C API: DDS_SampleInfo_publication_sequence_number

◆ ReceptionSequenceNumber

long Rti.Dds.Subscription.SampleInfo.ReceptionSequenceNumber
get

The reception sequence number when sample was committed by a DataReader

The full documentation is available in the C API: DDS_SampleInfo_reception_sequence_number

◆ PublicationVirtualSampleIdentity

SampleIdentity Rti.Dds.Subscription.SampleInfo.PublicationVirtualSampleIdentity
get

The original publication virtual sample identity.

The full documentation is available in the C API: DDS_SampleInfo_original_publication_virtual_guid

◆ OriginalPublicationVirtualSampleIdentity

SampleIdentity Rti.Dds.Subscription.SampleInfo.OriginalPublicationVirtualSampleIdentity
get

The original publication virtual identity.

The full documentation is available in the C API: DDS_SampleInfo_original_publication_virtual_guid

◆ RelatedOriginalPublicationVirtualSampleIdentity

SampleIdentity Rti.Dds.Subscription.SampleInfo.RelatedOriginalPublicationVirtualSampleIdentity
get

The original publication virtual identity of a related sample.

The full documentation is available in the C API: DDS_SampleInfo_related_original_publication_virtual_guid

◆ Flag

int Rti.Dds.Subscription.SampleInfo.Flag
get

Flags associated with the sample.

The full documentation is available in the C API: DDS_SampleInfo_flag

◆ SourceGuid

Guid Rti.Dds.Subscription.SampleInfo.SourceGuid
get

The application logical data source associated with the sample.

The full documentation is available in the C API: DDS_SampleInfo_source_guid

◆ RelatedSourceGuid

Guid Rti.Dds.Subscription.SampleInfo.RelatedSourceGuid
get

The application logical data source that is related to the sample.

The full documentation is available in the C API: DDS_SampleInfo_related_source_guid

◆ RelatedSubscriptionGuid

Guid Rti.Dds.Subscription.SampleInfo.RelatedSubscriptionGuid
get

The related_reader_guid associated with the sample.

The full documentation is available in the C API: DDS_SampleInfo_related_subscription_guid

◆ TopicQueryGuid

Guid Rti.Dds.Subscription.SampleInfo.TopicQueryGuid
get

The Guid of the TopicQuery that is related to the sample.

The full documentation is available in the C API: DDS_SampleInfo_topic_query_guid

◆ CoherentSetInfo

CoherentSetInfo Rti.Dds.Subscription.SampleInfo.CoherentSetInfo
get

If this sample belongs to a coherent set, this property contains information about the coherent set.

A nonnull object if this sample belongs to a coherent or null if it doesn't.