RTI Recording Service Version 7.3.0
|
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 rti::core::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: More... | |
SelectorState & | sample_state (const dds::sub::status::SampleState &state) |
Sets the sample state. More... | |
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. More... | |
int64_t | timestamp_range_start () const |
Like the time_range_start() method, but returns the timestamp in long long (int-64) format. More... | |
SelectorState & | time_range_start (const dds::core::Time &time_range_start) |
Sets the lower limit of the time range. More... | |
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. More... | |
int64_t | timestamp_range_end () const |
Like the time_range_end() method, but returns the timestamp in long long (int-64) format. More... | |
SelectorState & | time_range_end (const dds::core::Time &time_range_end) |
Sets the upper limit of the time range. More... | |
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. More... | |
SelectorState & | max_samples (const int32_t max_samples) |
Sets the maximum number of samples to be returned by a single call to read(). More... | |
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).
|
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:
References sample_state().
Referenced by sample_state().
|
inline |
Sets the sample state.
References sample_state().
|
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.
References time_range_start().
Referenced by time_range_start(), and timestamp_range_start().
|
inline |
Like the time_range_start() method, but returns the timestamp in long long (int-64) format.
References time_range_start().
|
inline |
Sets the lower limit of the time range.
References time_range_start().
|
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.
References time_range_end().
Referenced by time_range_end(), and timestamp_range_end().
|
inline |
Like the time_range_end() method, but returns the timestamp in long long (int-64) format.
References time_range_end().
|
inline |
Sets the upper limit of the time range.
References time_range_end().
|
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.
Referenced by max_samples().
|
inline |
Sets the maximum number of samples to be returned by a single call to read().
References max_samples().