RTI Recording Service  Version 6.0.1
 All Data Structures Namespaces Files Functions Typedefs Enumerations Enumerator Groups
rti::recording::storage::SelectorState Class Reference

This class is used by Replay Service or Converter when asking the storage plugin for data. It specifies whether the samples should be 'not read' samples, that haven't been returned before, or that 'any' sample state is needed. It also allows to specify the time range the samples returned have to lay within (upper and lower limit). More...

#include <SelectorState.hpp>

Inherits NativeValueType< SelectorState >.

Public Member Functions

dds::sub::status::SampleState sample_state () const
 Returns the sample state. This is used to represent the state of the samples asked for, whether they have been already read or not. When this value is set to:
 
SelectorStatesample_state (const dds::sub::status::SampleState &state)
 Sets the sample state.
 
dds::core::Time time_range_start () const
 Returns the time that represents the lower limit (inclusive) of the time range the retrieved data samples should lay within. When retrieving stateful samples (not read), this parameter becomes irrelevant as the lower limit should be the time-stamp of the latest sample returned.
 
int64_t timestamp_range_start () const
 Like the time_range_start() method, but returns the timestamp in long long (int-64) format.
 
SelectorStatetime_range_start (const dds::core::Time &time_range_start)
 Sets the lower limit of the time range.
 
dds::core::Time time_range_end () const
 Returns the time that represents the upper limit (inclusive) of the time range the retrieved samples should lay within. This parameter is always relevant, as samples should be returned in increasing time-stamp order.
 
int64_t timestamp_range_end () const
 Like the time_range_end() method, but returns the timestamp in long long (int-64) format.
 
SelectorStatetime_range_end (const dds::core::Time &time_range_end)
 Sets the upper limit of the time range.
 
int32_t max_samples () const
 Returns the maximum number of samples to be returned by a single read() call, when the value is positive. A negative value indicates an unlimited number of samples.
 
SelectorStatemax_samples (const int32_t max_samples)
 Sets the maximum number of samples to be returned by a single call to read().
 

Detailed Description

This class is used by Replay Service or Converter when asking the storage plugin for data. It specifies whether the samples should be 'not read' samples, that haven't been returned before, or that 'any' sample state is needed. It also allows to specify the time range the samples returned have to lay within (upper and lower limit).

Member Function Documentation

dds::sub::status::SampleState rti::recording::storage::SelectorState::sample_state ( ) const
inline

Returns the sample state. This is used to represent the state of the samples asked for, whether they have been already read or not. When this value is set to:

  • Not read: the storage plugin should provide samples that hasn't provided before. This implies that the storage plugin has to keep track of what samples it has already returned and what samples it hasn't.
  • Any: the storage plugin should provide all the samples within the specified time range, no matter their read state. This implies a stateless read, the storage plugin is not supposed to keep track of what samples have been read or not in this case.
  • Read: in the current version, this sample state is not used by Replay Service or Converter.
SelectorState& rti::recording::storage::SelectorState::sample_state ( const dds::sub::status::SampleState &  state)
inline

Sets the sample state.

dds::core::Time rti::recording::storage::SelectorState::time_range_start ( ) const
inline

Returns the time that represents the lower limit (inclusive) of the time range the retrieved data samples should lay within. When retrieving stateful samples (not read), this parameter becomes irrelevant as the lower limit should be the time-stamp of the latest sample returned.

int64_t rti::recording::storage::SelectorState::timestamp_range_start ( ) const
inline

Like the time_range_start() method, but returns the timestamp in long long (int-64) format.

SelectorState& rti::recording::storage::SelectorState::time_range_start ( const dds::core::Time &  time_range_start)
inline

Sets the lower limit of the time range.

dds::core::Time rti::recording::storage::SelectorState::time_range_end ( ) const
inline

Returns the time that represents the upper limit (inclusive) of the time range the retrieved samples should lay within. This parameter is always relevant, as samples should be returned in increasing time-stamp order.

int64_t rti::recording::storage::SelectorState::timestamp_range_end ( ) const
inline

Like the time_range_end() method, but returns the timestamp in long long (int-64) format.

SelectorState& rti::recording::storage::SelectorState::time_range_end ( const dds::core::Time &  time_range_end)
inline

Sets the upper limit of the time range.

int32_t rti::recording::storage::SelectorState::max_samples ( ) const
inline

Returns the maximum number of samples to be returned by a single read() call, when the value is positive. A negative value indicates an unlimited number of samples.

SelectorState& rti::recording::storage::SelectorState::max_samples ( const int32_t  max_samples)
inline

Sets the maximum number of samples to be returned by a single call to read().


RTI Recording Service Version 6.0.1 Copyright © Sun Nov 17 2019 Real-Time Innovations, Inc