Account
| BdsApi 4.0.1 This is the Blacknest BDS API. |
Loading...
Searching...
No Matches
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="") | |
| DataError & | set (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. | |
| BString | getTitle () const |
| Get the title. | |
| BError | setString (BString str) |
| Set from string. | |
| BError | setStringUser (BString str, BString user) |
| Set from string given by user on command line. | |
| BString | getString () const |
| Get error message. | |
| int | num () const |
| Get The error number. | |
| const char * | str () const |
| Return a char* string. | |
| operator int () const | |
| Return error number. | |
Public Attributes | |
| BInt32 | oerrorNumber |
| Error number. | |
| BString | otitle |
| The title. | |
| BString | odescription |
| The description. | |
| BString | ofilename |
| The import filename;. | |
| BTimeStamp | ostartTime |
| The start Time. | |
| BTimeStamp | oendTime |
| The end Time. | |
| BString | onetwork |
| The network Name. | |
| BString | ostation |
| The station/array name. | |
| BString | ochannel |
| The channel name. | |
| BString | osource |
| The data Source. | |
| BString | ouser |
| The user. | |
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
◆ set()
| DataError & Bds::DataError::set | ( | int | errorNumber, |
| BString | title, | ||
| BString | importFilename, | ||
| BTimeStamp | startTime, | ||
| BTimeStamp | endTime, | ||
| DataInfo & | dataInfo, | ||
| BUInt | channel, | ||
| BString | description, | ||
| BString | user = "" | ||
| ) |
◆ mergeDataInfo()
◆ getErrorNumber()
| int Bds::DataError::getErrorNumber | ( | ) | const |
Get The error number.
◆ getTitle()
| BString Bds::DataError::getTitle | ( | ) | const |
Get the title.
◆ setString()
◆ setStringUser()
Set from string given by user on command line.
◆ getString()
| BString Bds::DataError::getString | ( | ) | const |
Get error message.
◆ num()
| int Bds::DataError::num | ( | ) | const |
Get The error number.
◆ str()
| const char * Bds::DataError::str | ( | ) | const |
Return a char* string.
◆ operator int()
| Bds::DataError::operator int | ( | ) | const |
Return error number.
Member Data Documentation
◆ oerrorNumber
| BInt32 Bds::DataError::oerrorNumber |
Error number.
◆ otitle
| BString Bds::DataError::otitle |
The title.
◆ odescription
| BString Bds::DataError::odescription |
The description.
◆ ofilename
| BString Bds::DataError::ofilename |
The import filename;.
◆ ostartTime
| BTimeStamp Bds::DataError::ostartTime |
The start Time.
◆ oendTime
| BTimeStamp Bds::DataError::oendTime |
The end Time.
◆ onetwork
| BString Bds::DataError::onetwork |
The network Name.
◆ ostation
| BString Bds::DataError::ostation |
The station/array name.
◆ ochannel
| BString Bds::DataError::ochannel |
The channel name.
◆ osource
◆ ouser
| BString Bds::DataError::ouser |
The user.
The documentation for this class was generated from the following files:
Generated by
