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

This stores a data error. It includes and error number and a string as well as information on what seismic channel it is for. More...

#include <BdsLib.h>

Public Member Functions

 DataError ()
 
 DataError (int errorNumber, BString title, BString filename, BTimeStamp startTime, BTimeStamp endTime, DataInfo &dataInfo, BUInt channel, BString description, BString user="")
 
DataErrorset (int errorNumber, BString title, BString importFilename, BTimeStamp startTime, BTimeStamp endTime, DataInfo &dataInfo, BUInt channel, BString description, BString user="")
 
void mergeDataInfo (const DataInfo &dataInfo, BUInt channel)
 
int getErrorNumber () const
 Get The error number. More...
 
BString getTitle () const
 Get the title. More...
 
BError setString (BString str)
 Set from string. More...
 
BError setStringUser (BString str, BString user)
 Set from string given by user on command line. More...
 
BString getString () const
 Get error message. More...
 
int num () const
 Get The error number. More...
 
const char * str () const
 Return a char* string. More...
 
 operator int () const
 Return error number. More...
 

Public Attributes

BInt32 oerrorNumber
 Error number. More...
 
BString otitle
 The title. More...
 
BString odescription
 The description. More...
 
BString ofilename
 The import filename;. More...
 
BTimeStamp ostartTime
 The start Time. More...
 
BTimeStamp oendTime
 The end Time. More...
 
BString onetwork
 The network Name. More...
 
BString ostation
 The station/array name. More...
 
BString ochannel
 The channel name. More...
 
BString osource
 The data Source. More...
 
BString ouser
 The user. More...
 

Detailed Description

This stores a data error. It includes and error number and a string as well as information on what seismic channel it is for.

Constructor & Destructor Documentation

◆ DataError() [1/2]

Bds::DataError::DataError ( )

◆ DataError() [2/2]

Bds::DataError::DataError ( int  errorNumber,
BString  title,
BString  filename,
BTimeStamp  startTime,
BTimeStamp  endTime,
DataInfo dataInfo,
BUInt  channel,
BString  description,
BString  user = "" 
)

Member Function Documentation

◆ getErrorNumber()

int Bds::DataError::getErrorNumber ( ) const

Get The error number.

◆ getString()

BString Bds::DataError::getString ( ) const

Get error message.

◆ getTitle()

BString Bds::DataError::getTitle ( ) const

Get the title.

◆ mergeDataInfo()

void Bds::DataError::mergeDataInfo ( const DataInfo dataInfo,
BUInt  channel 
)

◆ num()

int Bds::DataError::num ( ) const

Get The error number.

◆ operator int()

Bds::DataError::operator int ( ) const

Return error number.

◆ set()

DataError & Bds::DataError::set ( int  errorNumber,
BString  title,
BString  importFilename,
BTimeStamp  startTime,
BTimeStamp  endTime,
DataInfo dataInfo,
BUInt  channel,
BString  description,
BString  user = "" 
)

◆ setString()

BError Bds::DataError::setString ( BString  str)

Set from string.

◆ setStringUser()

BError Bds::DataError::setStringUser ( BString  str,
BString  user 
)

Set from string given by user on command line.

◆ str()

const char * Bds::DataError::str ( ) const

Return a char* string.

Member Data Documentation

◆ ochannel

BString Bds::DataError::ochannel

The channel name.

◆ odescription

BString Bds::DataError::odescription

The description.

◆ oendTime

BTimeStamp Bds::DataError::oendTime

The end Time.

◆ oerrorNumber

BInt32 Bds::DataError::oerrorNumber

Error number.

◆ ofilename

BString Bds::DataError::ofilename

The import filename;.

◆ onetwork

BString Bds::DataError::onetwork

The network Name.

◆ osource

BString Bds::DataError::osource

The data Source.

◆ ostartTime

BTimeStamp Bds::DataError::ostartTime

The start Time.

◆ ostation

BString Bds::DataError::ostation

The station/array name.

◆ otitle

BString Bds::DataError::otitle

The title.

◆ ouser

BString Bds::DataError::ouser

The user.


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