dds::sub::Rank Class Reference

<<value-type>> Contains the sample and generation ranks of a data-sample More...

#include <TRank.hpp>

Public Member Functions
	Rank ()
	Create a default Rank object. More...
	Rank (int32_t sample_rank, int32_t generation_rank, int32_t absolute_generation_rank)
	Create a Rank object with the provided sample_rank, generation_rank, and absolute_generation_rank. More...
int32_t	sample () const
	Get the sample rank of the sample. More...
int32_t	generation () const
	Get the generation rank of the sample. More...
int32_t	absolute_generation () const
	Get the absolute generation rank of the sample. More...

Detailed Description

<<value-type>> Contains the sample and generation ranks of a data-sample

See also

dds::sub::SampleInfo::rank()

Constructor & Destructor Documentation

Rank() [1/2]

dds::sub::Rank::Rank ( )

inline

Create a default Rank object.

References dds::core::Value< D >::delegate().

Rank() [2/2]

dds::sub::Rank::Rank ( int32_t  sample_rank, int32_t  generation_rank, int32_t  absolute_generation_rank  )

inline

Create a Rank object with the provided sample_rank, generation_rank, and absolute_generation_rank.

Member Function Documentation

sample()

int32_t dds::sub::Rank::sample ( ) const

inline

Get the sample rank of the sample.

The sample rank of the sample.

Indicates the number of samples related to the same instance that follow in the collection returned by read or take.

See also

Interpretation of the SampleInfo sample_rank, generation_rank and absolute_generation_rank Interpretation of the SampleInfo counters and ranks

generation()

int32_t dds::sub::Rank::generation ( ) const

inline

Get the generation rank of the sample.

The generation rank of the sample.

Indicates the generation difference (number of times the instance was NOT_ALIVE and become alive again) between the time the sample was received and the time the most recent sample in the collection related to the same instance was received.

See also

Interpretation of the SampleInfo sample_rank, generation_rank and absolute_generation_rank Interpretation of the SampleInfo counters and ranks

absolute_generation()

int32_t dds::sub::Rank::absolute_generation ( ) const

inline

Get the absolute generation rank of the sample.

The absolute generation rank of the sample.

Indicates the generation difference (number of times the instance was disposed and become alive again) between the time the sample was received, and the time the most recent sample (which may not be in the returned collection) related to the same instance was received.

See also

Interpretation of the SampleInfo sample_rank, generation_rank and absolute_generation_rank Interpretation of the SampleInfo counters and ranks