|
SampleInfo Class |
Information that accompanies each sample that is read or taken.
Inheritance HierarchyNamespace: OpenDDSharp.DDS
Assembly: OpenDDSharp (in OpenDDSharp.dll) Version: 0.5.0.0
SyntaxThe SampleInfo type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SampleInfo |
Creates a new instance of SampleInfo |
Properties| Name | Description | |
|---|---|---|
 | AbsoluteGenerationRank |
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.
|
| DisposedGenerationCount |
The number of times the instance has become 'Alive' after being explicitly disposed.
|
| GenerationRank |
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.
|
| InstanceHandle |
The handle that locally identifies the associated instance.
|
| InstanceState |
Indicates whether the associated instance currently exists.
|
| NoWritersGenerationCount |
The number of times the instance has become 'Alive' after being automatically disposed due to no active writers.
|
| PublicationHandle |
The local handle of the source DataWriter.
|
| SampleRank |
Number of samples related to this instances that follow in the collection returned by the DataReader read or take operations.
|
| SampleState |
The associated data sample has/has not been read previously.
|
| SourceTimestamp |
The time provided by the DataWriter when the sample was written.
|
| ValidData |
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).
|
| ViewState |
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.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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