nds2-client - ClientDeveloper
0.16.8
|
A predicate object to be used in limiting the number of channels returned when searching for channels. More...
#include <nds_connection.hh>
Public Types | |
typedef std::vector < NDS::channel::channel_type > | channel_type_list |
typedef std::vector < NDS::channel::data_type > | data_type_list |
Public Member Functions | |
channel_predicate_object () | |
channel_predicate_object (const channel_predicate_object &other)=default | |
channel_predicate_object (channel_predicate_object &&other)=default | |
channel_predicate_object & | operator= (const channel_predicate_object &other)=default |
channel_predicate_object & | operator= (channel_predicate_object &&other)=default |
std::string | glob () const |
Return the channel name glob (defaults to "*") More... | |
const channel_type_list | channel_types () const |
return a container of distinct channel types that are to be matched (defaults to an expansion of NDS::channel::DEFAULT_CHANNEL_MASK) More... | |
NDS::channel::channel_type | channel_type_mask () const |
return a compact mask of the channel types selected. this is mainly provided for the SWIG language bindings. More... | |
const data_type_list | data_types () const |
return a container of distinct data types that are to be matched (defaults to an expansion of NDS::channel::DEFAULT_DATA_MASK) More... | |
NDS::channel::data_type | data_type_mask () const |
return a compact mask of the data types selected. this is mainly provided for the SWIG language bindings. More... | |
const frequency_range & | sample_rates () const |
return the range of sample rates that are to be allowed in the query. defaults to (NDS::channel::MIN_SAMPLE_RATE, NDS::channel::MAX_SAMPLE_RATE) More... | |
NDS::channel::sample_rate_type | min_sample_rate () const |
return the minimum sample rate to be selected. This is also available through the sample_rates method. More... | |
NDS::channel::sample_rate_type | max_sample_rate () const |
return the maximum sample rate to be selected. This is also available through the sample_rates method. More... | |
const epoch & | time_span () const |
return the timespan/epoch that should constrain the query defaults to [0, NDS::buffer::GPS_INF) More... | |
NDS::buffer::gps_second_type | gps_start () const |
Return the gps start time that constrains this query. Note this is available via the time_span method. More... | |
NDS::buffer::gps_second_type | gps_stop () const |
Return the gps stop time that constrains this query. Note this is available via the time_span method. More... | |
channel_predicate_object & | set (std::string val) |
Set the glob string used in channel matching. More... | |
void | set_glob (std::string val) |
Set the glob string to match on. More... | |
channel_predicate_object & | set (NDS::channel::channel_type val) |
Set a channel type to search for. More... | |
void | set_channel_type_mask (NDS::channel::channel_type val) |
Set the channel type mask. More... | |
channel_predicate_object & | set (NDS::channel::data_type val) |
Set a data type to search for. More... | |
void | set_data_type_mask (NDS::channel::data_type val) |
Set the data type mask. More... | |
channel_predicate_object & | set (frequency_range val) |
void | set_frequency_range (NDS::channel::sample_rate_type min_sample_rate, NDS::channel::sample_rate_type max_sample_rate) |
Set the [min, max) frequency range that limits this query. More... | |
channel_predicate_object & | set (epoch val) |
void | set_timespan (NDS::buffer::gps_second_type gps_start, NDS::buffer::gps_second_type gps_stop) |
Set the [gps_start, gps_stop) time range that limits this query. More... | |
Private Attributes | |
epoch | epoch_ |
std::string | glob_ |
channel_type_list | channel_types_ |
data_type_list | data_types_ |
frequency_range | sample_rates_ |
Static Private Attributes | |
DLL_EXPORT static const data_type_list | all_data_types |
DLL_EXPORT static const channel_type_list | all_channel_types |
A predicate object to be used in limiting the number of channels returned when searching for channels.
This object holds the various conditions that the nds2_client library will use when searching channels. The conditions (NDS epoch, name globbing, sample rates, channel type, data type, ...) are all specified in a uniform manner. Each condition should have a distinct type.
typedef std::vector< NDS::channel::channel_type > NDS::abi_0::channel_predicate_object::channel_type_list |
typedef std::vector< NDS::channel::data_type > NDS::abi_0::channel_predicate_object::data_type_list |
|
inline |
|
default |
|
default |
|
inline |
return a compact mask of the channel types selected. this is mainly provided for the SWIG language bindings.
|
inline |
return a container of distinct channel types that are to be matched (defaults to an expansion of NDS::channel::DEFAULT_CHANNEL_MASK)
|
inline |
return a compact mask of the data types selected. this is mainly provided for the SWIG language bindings.
|
inline |
return a container of distinct data types that are to be matched (defaults to an expansion of NDS::channel::DEFAULT_DATA_MASK)
|
inline |
Return the channel name glob (defaults to "*")
|
inline |
Return the gps start time that constrains this query. Note this is available via the time_span method.
|
inline |
Return the gps stop time that constrains this query. Note this is available via the time_span method.
|
inline |
return the maximum sample rate to be selected. This is also available through the sample_rates method.
|
inline |
return the minimum sample rate to be selected. This is also available through the sample_rates method.
|
default |
|
default |
|
inline |
return the range of sample rates that are to be allowed in the query. defaults to (NDS::channel::MIN_SAMPLE_RATE, NDS::channel::MAX_SAMPLE_RATE)
|
inline |
Set the glob string used in channel matching.
val | The glob string to match with |
|
inline |
Set a channel type to search for.
val | The channel type to search for. |
|
inline |
Set a data type to search for.
val | The data type to search for. |
|
inline |
Set the sample rate rate to search for
val | The sample rate range |
|
inline |
Set the epoch/time span for the predicate
val | A NDS::epoch representing the timespan |
|
inline |
Set the channel type mask.
val |
|
inline |
Set the data type mask.
val |
|
inline |
Set the [min, max) frequency range that limits this query.
min_sample_rate | The minimal sample rate |
max_sample_rate | The maximum sample rate |
|
inline |
Set the glob string to match on.
val |
|
inline |
Set the [gps_start, gps_stop) time range that limits this query.
gps_start | Start time in GPS Seconds |
gps_stop | End time in GPS Seconds exclusive. |
|
inline |
return the timespan/epoch that should constrain the query defaults to [0, NDS::buffer::GPS_INF)
|
staticprivate |
|
staticprivate |
|
private |
|
private |
|
private |
|
private |
|
private |