BdsApi  3.0.12
This is the Blacknest BDS API.
Public Member Functions | Public Attributes | List of all members
Bds::Selection Class Reference

This class defines a generic metadata or seismic 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. More...
 
ListRange range
 The range of data to return. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time. More...
 
BList< SelectionChannelchannels
 The data channels to select. More...
 
BUInt32 channelId
 The Channel id. More...
 
BUInt32 digitiserId
 The Digitiser id. More...
 
BUInt32 sensorId
 The Sensor id. More...
 
BUInt32 sensorOldId
 The Sensor old id. More...
 
BInt32 completeSegments
 Do not clip the segment times to match the required time period. More...
 
BString calibrationName
 Calibration name to use. More...
 
BString array
 Channels are based on the given array (for array offsets) More...
 
BUInt32 eventId
 A particular event's ID. More...
 
BString name
 Match the name, title or some other string in the objects to select. More...
 
LocationSelect locationSelect
 Which locations to select, those for stations, channels or all of them when used in a locationGetList() call. More...
 
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. More...
 
BString excludeChannels
 Comma separated wildcard list of channels to be excluded. More...
 

Detailed Description

This class defines a generic metadata or seismic data selection.

This defines a set of selection criteria when selecting items from the BDS metadata or seismic data sets. The fields, when set, limit the ietms returned by the settings provided. In effect it has an "AND" type of function with the parameters provided. 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

◆ array

BString Bds::Selection::array

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

◆ calibrationName

BString Bds::Selection::calibrationName

Calibration name to use.

◆ channelId

BUInt32 Bds::Selection::channelId

The Channel id.

◆ channels

BList<SelectionChannel > Bds::Selection::channels

The data channels to select.

◆ completeSegments

BInt32 Bds::Selection::completeSegments

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

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

◆ digitiserId

BUInt32 Bds::Selection::digitiserId

The Digitiser id.

◆ endTime

BTimeStamp Bds::Selection::endTime

The End Time.

◆ eventId

BUInt32 Bds::Selection::eventId

A particular event's ID.

◆ excludeChannels

BString Bds::Selection::excludeChannels

Comma separated wildcard list of channels to be excluded.

◆ id

BUInt32 Bds::Selection::id

The ID of the record to return.

◆ locationSelect

LocationSelect Bds::Selection::locationSelect

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

◆ name

BString Bds::Selection::name

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

◆ range

ListRange Bds::Selection::range

The range of data to return.

◆ sensorId

BUInt32 Bds::Selection::sensorId

The Sensor id.

◆ sensorOldId

BUInt32 Bds::Selection::sensorOldId

The Sensor old id.

◆ startTime

BTimeStamp Bds::Selection::startTime

The Start Time.


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