BdsApi  2.2.6
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
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())
 

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

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

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() 
)

Member Data Documentation

BString Bds::Selection::calibrationName

Calibration name to use.

BUInt32 Bds::Selection::channelId

The Channel id.

BList<SelectionChannel > Bds::Selection::channels

The data channels to select.

BInt32 Bds::Selection::completeSegments

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

BUInt32 Bds::Selection::digitiserId

The Digitiser id.

BTimeStamp Bds::Selection::endTime

The End Time.

BUInt32 Bds::Selection::id

The ID of the record to return.

ListRange Bds::Selection::range

The range of data to return.

BUInt32 Bds::Selection::sensorId

The Sensor id.

BUInt32 Bds::Selection::sensorOldId

The Sensor old id.

BTimeStamp Bds::Selection::startTime

The Start Time.


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