A predicate object to be used in limiting the number of channels returned when searching for channels. More...

#include <nds_connection.hh>

Public Member Functions
std::string	glob () const
	Return the channel name glob (defaults to "*")

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)

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.

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)

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.

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)

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.

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.

const epoch &	time_span () const
	return the timespan/epoch that should constrain the query defaults to [0, NDS::buffer::GPS_INF)

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.

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.

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...

Detailed Description

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.

Member Function Documentation

channel_predicate_object& NDS::abi_0::channel_predicate_object::set ( std::string val )

inline

Set the glob string used in channel matching.

Parameters

val	The glob string to match with

Returns: This object

channel_predicate_object& NDS::abi_0::channel_predicate_object::set ( NDS::channel::channel_type val )

inline

Set a channel type to search for.

Parameters

val	The channel type to search for.

Returns: This object

Note: This may be called multiple times, each additional type expands the search space

channel_predicate_object& NDS::abi_0::channel_predicate_object::set ( NDS::channel::data_type val )

inline

Set a data type to search for.

Parameters

val	The data type to search for.

Returns: This object

Note: This may be called multiple times, each additional type expands the search space

channel_predicate_object& NDS::abi_0::channel_predicate_object::set ( frequency_range val )

inline

Set the sample rate rate to search for

Parameters

val	The sample rate range

Returns: This object

channel_predicate_object& NDS::abi_0::channel_predicate_object::set ( epoch val )

inline

Set the epoch/time span for the predicate

Parameters

val	A NDS::epoch representing the timespan

Returns: This object

void NDS::abi_0::channel_predicate_object::set_channel_type_mask ( NDS::channel::channel_type val )

inline

Set the channel type mask.

Parameters

val

Note: this calls set(channel_type)

void NDS::abi_0::channel_predicate_object::set_data_type_mask ( NDS::channel::data_type val )

inline

Set the data type mask.

Parameters

val

Note: this calls set(data_type)

void NDS::abi_0::channel_predicate_object::set_frequency_range	(	NDS::channel::sample_rate_type	min_sample_rate,
		NDS::channel::sample_rate_type	max_sample_rate
	)

inline

Set the [min, max) frequency range that limits this query.

Parameters

min_sample_rate	The minimal sample rate
max_sample_rate	The maximum sample rate

Note: this calls set(frequency_range)

void NDS::abi_0::channel_predicate_object::set_glob ( std::string val )

inline

Set the glob string to match on.

Parameters

val

Note: this calls set(string)

void NDS::abi_0::channel_predicate_object::set_timespan	(	NDS::buffer::gps_second_type	gps_start,
		NDS::buffer::gps_second_type	gps_stop
	)

inline

Set the [gps_start, gps_stop) time range that limits this query.

Parameters

gps_start	Start time in GPS Seconds
gps_stop	End time in GPS Seconds exclusive.

Note: this calls set(epoch)

The documentation for this class was generated from the following files:

src/libndscxx/module/nds_connection.hh
src/libndscxx/module/nds_connection.cc

Public Member Functions

Detailed Description

Member Function Documentation