NDS::abi_0::request_period Struct Reference

This represents a [start, stop) time with an optional data stride. More...

#include <nds_data_iterator.hh>

Public Types
using	gps_second_type = NDS::buffer::gps_second_type
typedef long	stride_type

Public Member Functions
	request_period ()
	Default constructor, represent a request for an endless amount of live data. More...
	request_period (stride_type requested_stride)
	Represent a request for an endless amount of live data with a given stride. More...
	request_period (gps_second_type requested_start, gps_second_type requested_stop)
	Represent a request for bounded data [start, stop) More...
	request_period (gps_second_type requested_start, gps_second_type requested_stop, stride_type requested_stride)
	Represent a request for bounded data [start, stop) with a stride. More...

Public Attributes
gps_second_type	start
gps_second_type	stop
stride_type	stride

Static Public Attributes
static const stride_type	FAST_STRIDE = -1
	a data stride of FAST_STRIDE requests sub-second data if possible. On systems that do not support sub-second data this is treated as AUTO_STRIDE. More...
static const stride_type	AUTO_STRIDE = 0
	a data stride of AUTO_STRIDE requests that the NDS systems determine the stride of data. For online requests this will typically be 1s, for offline data this may vary but is likely to be around the size of a data frame. More...

Detailed Description

This represents a [start, stop) time with an optional data stride.

This is used to represent a time range associated with a data request. Constructors are provided to allow requesting a [start, stop) time in the past, a bounded request of live data [0, duration), and an endless request of live data [0, infinite).

Member Typedef Documentation

using NDS::abi_0::request_period::gps_second_type = NDS::buffer::gps_second_type

typedef long NDS::abi_0::request_period::stride_type

Constructor & Destructor Documentation

NDS::abi_0::request_period::request_period ( )

inline

Default constructor, represent a request for an endless amount of live data.

NDS::abi_0::request_period::request_period ( stride_type  requested_stride )

inlineexplicit

Represent a request for an endless amount of live data with a given stride.

Parameters

requested_stride

The number of seconds to return in each iteration.

Note

the requested_stride should be considered a requested max, the server may return less.

NDS::abi_0::request_period::request_period ( gps_second_type  requested_start, gps_second_type  requested_stop  )

inlineexplicit

Represent a request for bounded data [start, stop)

Parameters

requested_start	The start time, 0 represents live/online data, else a gps time
requested_stop	For online data this is the duration, otherwise it is the stop time

Note

the requested_stride should be considered a requested max, the server may return less.

NDS::abi_0::request_period::request_period ( gps_second_type  requested_start, gps_second_type  requested_stop, stride_type  requested_stride  )

inlineexplicit

Represent a request for bounded data [start, stop) with a stride.

Parameters

requested_start	The start time, 0 represents live/online data, else a gps time
requested_stop	For online data this is the duration, otherwise it is the stop time
requested_stride	The number of seconds to return data for each iteration.

Note

the requested_stride should be considered a requested max, the server may return less.

Member Data Documentation

const stride_type NDS::abi_0::request_period::AUTO_STRIDE = 0

static

a data stride of AUTO_STRIDE requests that the NDS systems determine the stride of data. For online requests this will typically be 1s, for offline data this may vary but is likely to be around the size of a data frame.

const stride_type NDS::abi_0::request_period::FAST_STRIDE = -1

static

a data stride of FAST_STRIDE requests sub-second data if possible. On systems that do not support sub-second data this is treated as AUTO_STRIDE.

gps_second_type NDS::abi_0::request_period::start

gps_second_type NDS::abi_0::request_period::stop

stride_type NDS::abi_0::request_period::stride

---

The documentation for this struct was generated from the following file:

• src/libndscxx/module/nds_data_iterator.hh