This class defines a generic Metadata or Sensor data selection. More...

#include <BdsD.h>

Public Member Functions
	Selection (BUInt32 id=0, ListRange range=ListRange(), BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BList< SelectionChannel > channels=BList< SelectionChannel >(), BUInt32 channelId=0, BUInt32 digitiserId=0, BUInt32 sensorId=0, BUInt32 sensorOldId=0, BInt32 completeSegments=0, BString calibrationName=BString(), BString array=BString(), BUInt32 eventId=0, BString name=BString(), LocationSelect locationSelect=LocationSelect(), BString dataTypes=BString(), BString excludeChannels=BString())

Public Attributes
BUInt32	id
	The ID of the record to return.

ListRange	range
	The range of data to return.

BTimeStamp	startTime
	The Start Time.

BTimeStamp	endTime
	The End Time.

BList< SelectionChannel >	channels
	The data channels to select.

BUInt32	channelId
	The Channel id.

BUInt32	digitiserId
	The Digitiser id.

BUInt32	sensorId
	The Sensor id.

BUInt32	sensorOldId
	The Sensor old id.

BInt32	completeSegments
	Do not clip the segment times to match the required time period.

BString	calibrationName
	Calibration name to use.

BString	array
	Channels are based on the given array (for array offsets)

BUInt32	eventId
	A particular event's ID.

BString	name
	Match the name, title or some other string in the objects to select.

LocationSelect	locationSelect
	Which locations to select, those for stations, channels or all of them when used in a locationGetList() call.

BString	dataTypes
	Place holder as yet for: A comma separated list of Channel dataTypes to select when returning Channels. If set to null all Channel dataTypes are returned.

BString	excludeChannels
	Comma separated wildcard list of channels to be excluded.

Detailed Description

This class defines a generic Metadata or Sensor data selection.

This defines a set of selection criteria when selecting items from the BDS Metadata or Sensor data sets. The fields, when set, limit the items returned as defined by the setting fields provided. In effect these have an "AND" type of function with the parameters provided. Most of the string parameters can be provided as regular expressions. The core section fields are the startTime, endTime and channels fields. As well as thses there are some specific parameters like: channelId, digitiserId, sensorId etc which are used with specific data selection functions.

Constructor & Destructor Documentation

◆ Selection()

Bds::Selection::Selection	(	BUInt32	id = `0`,
		ListRange	range = `ListRange()`,
		BTimeStamp	startTime = `BTimeStamp()`,
		BTimeStamp	endTime = `BTimeStamp()`,
		BList< SelectionChannel >	channels = `BList<SelectionChannel >()`,
		BUInt32	channelId = `0`,
		BUInt32	digitiserId = `0`,
		BUInt32	sensorId = `0`,
		BUInt32	sensorOldId = `0`,
		BInt32	completeSegments = `0`,
		BString	calibrationName = `BString()`,
		BString	array = `BString()`,
		BUInt32	eventId = `0`,
		BString	name = `BString()`,
		LocationSelect	locationSelect = `LocationSelect()`,
		BString	dataTypes = `BString()`,
		BString	excludeChannels = `BString()`
	)

Member Data Documentation

◆ id

BUInt32 Bds::Selection::id

The ID of the record to return.

◆ range

ListRange Bds::Selection::range

The range of data to return.

◆ startTime

BTimeStamp Bds::Selection::startTime

The Start Time.

◆ endTime

BTimeStamp Bds::Selection::endTime

The End Time.

◆ channels

BList<SelectionChannel > Bds::Selection::channels

The data channels to select.

◆ channelId

BUInt32 Bds::Selection::channelId

The Channel id.

◆ digitiserId

BUInt32 Bds::Selection::digitiserId

The Digitiser id.

◆ sensorId

BUInt32 Bds::Selection::sensorId

The Sensor id.

◆ sensorOldId

BUInt32 Bds::Selection::sensorOldId

The Sensor old id.

◆ completeSegments

BInt32 Bds::Selection::completeSegments

Do not clip the segment times to match the required time period.

◆ calibrationName

BString Bds::Selection::calibrationName

Calibration name to use.

◆ array

BString Bds::Selection::array

Channels are based on the given array (for array offsets)

◆ eventId

BUInt32 Bds::Selection::eventId

A particular event's ID.

◆ name

BString Bds::Selection::name

Match the name, title or some other string in the objects to select.

◆ locationSelect

LocationSelect Bds::Selection::locationSelect

Which locations to select, those for stations, channels or all of them when used in a locationGetList() call.

◆ dataTypes

BString Bds::Selection::dataTypes

Place holder as yet for: A comma separated list of Channel dataTypes to select when returning Channels. If set to null all Channel dataTypes are returned.

◆ excludeChannels

BString Bds::Selection::excludeChannels

Comma separated wildcard list of channels to be excluded.

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

Account

Public Member Functions

Public Attributes