Click or drag to resize

SampleInfo Class

Information that accompanies each sample that is read or taken.
Inheritance Hierarchy
SystemObject
  OpenDDSharp.DDSSampleInfo

Namespace:  OpenDDSharp.DDS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public class SampleInfo

The SampleInfo type exposes the following members.

Constructors
  NameDescription
Public methodSampleInfo
Creates a new instance of SampleInfo
Top
Properties
  NameDescription
Public propertyAbsoluteGenerationRank
The generation difference between this sample and the most recent sample. The AbsoluteGenerationRank indicates the generation difference (ie, the number of times the instance was disposed and became alive again) between this sample, and the most recent sample (possibly not in the returned collection) of this instance.
Public propertyDisposedGenerationCount
The number of times the instance has become 'Alive' after being explicitly disposed.
Public propertyGenerationRank
The generation difference of this sample and the most recent sample in the collection. GenerationRank indicates the generation difference (ie, the number of times the instance was disposed and became alive again) between this sample, and the most recent sample in the collection related to this instance.
Public propertyInstanceHandle
The handle that locally identifies the associated instance.
Public propertyInstanceState
Indicates whether the associated instance currently exists.
Public propertyNoWritersGenerationCount
The number of times the instance has become 'Alive' after being automatically disposed due to no active writers.
Public propertyPublicationHandle
The local handle of the source DataWriter.
Public propertySampleRank
Number of samples related to this instances that follow in the collection returned by the DataReader read or take operations.
Public propertySampleState
The associated data sample has/has not been read previously.
Public propertySourceTimestamp
The time provided by the DataWriter when the sample was written.
Public propertyValidData
Is set to if the associated DataSample contains data. The associated DataSample may not contain data if it this sample indicates a change in sample state (for example Alive -> Disposed).
Public propertyViewState
Associated instance has/has not been seen before. ViewState indicates whether the DataReader has already seen samples for the most current generation of the related instance.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The SampleInfo structure contains information associated with each Sample. The DataReader read and take operations return two vectors. One vector contains Sample(s) and the other contains SampleInfo(s). There is a one-to-one correspondence between items in these two vectors. Each Sample is described by the corresponding SampleInfo instance.
See Also