BdsApi
2.2.7
This is the Blacknest BDS API.
|
This holds information on a Note for general information. More...
#include <BdsD.h>
Public Member Functions | |
Note (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BString type=BString(), BString user=BString(), BTimeStamp timeAdded=BTimeStamp(), BInt32 errorNumber=0, BString title=BString(), BString description=BString(), BString docFormat=BString(), BString docUrl=BString(), BUInt32 dataFileId=0, BString importFilename=BString()) | |
BString | getType () |
BError | setMembers (BDictString &members) |
BError | setMember (BString name, BString value) |
BError | getMembers (BDictString &members) |
BError | getMember (BString name, BString &value) |
![]() | |
BObj () | |
virtual | ~BObj () |
virtual const char * | getType () const |
virtual const BObjMember * | getMembers () const |
virtual void | membersPrint () const |
virtual BString | getDebugString () |
Public Attributes | |
BUInt32 | id |
The unique id. More... | |
BTimeStamp | startTime |
The Start Time note is for. More... | |
BTimeStamp | endTime |
The End Time note is for. More... | |
BString | network |
The Network Name. More... | |
BString | station |
The Station/Array name. More... | |
BString | channel |
The Channels name. More... | |
BString | source |
The Data Source. More... | |
BString | type |
The Type (note, warning, error ...) More... | |
BString | user |
The user. More... | |
BTimeStamp | timeAdded |
The Time Entered. More... | |
BInt32 | errorNumber |
Error number if error. More... | |
BString | title |
The title. More... | |
BString | description |
The Description. More... | |
BString | docFormat |
Document format if any. More... | |
BString | docUrl |
Document Url if any. More... | |
BUInt32 | dataFileId |
The data file id associated with this note. More... | |
BString | importFilename |
The import filename. More... | |
This holds information on a Note for general information.
Normally a Note can be added for a particular set of data over a particular time period. These notes are sometimes added automaically during a data import process or by a user. A data user can then ask for any notes for a particular set of data.
Bds::Note::Note | ( | BUInt32 | id = 0 , |
BTimeStamp | startTime = BTimeStamp() , |
||
BTimeStamp | endTime = BTimeStamp() , |
||
BString | network = BString() , |
||
BString | station = BString() , |
||
BString | channel = BString() , |
||
BString | source = BString() , |
||
BString | type = BString() , |
||
BString | user = BString() , |
||
BTimeStamp | timeAdded = BTimeStamp() , |
||
BInt32 | errorNumber = 0 , |
||
BString | title = BString() , |
||
BString | description = BString() , |
||
BString | docFormat = BString() , |
||
BString | docUrl = BString() , |
||
BUInt32 | dataFileId = 0 , |
||
BString | importFilename = BString() |
||
) |
|
virtual |
Reimplemented from BObj.
BString Bds::Note::getType | ( | ) |
|
virtual |
Reimplemented from BObj.
BString Bds::Note::channel |
The Channels name.
BUInt32 Bds::Note::dataFileId |
The data file id associated with this note.
BString Bds::Note::description |
The Description.
BString Bds::Note::docFormat |
Document format if any.
BString Bds::Note::docUrl |
Document Url if any.
BTimeStamp Bds::Note::endTime |
The End Time note is for.
BInt32 Bds::Note::errorNumber |
Error number if error.
BUInt32 Bds::Note::id |
The unique id.
BString Bds::Note::importFilename |
The import filename.
BTimeStamp Bds::Note::startTime |
The Start Time note is for.
BString Bds::Note::station |
The Station/Array name.
BTimeStamp Bds::Note::timeAdded |
The Time Entered.
BString Bds::Note::title |
The title.
BString Bds::Note::type |
The Type (note, warning, error ...)
BString Bds::Note::user |
The user.