BDS Public
BdsApi  2.0.11

This holds information on a Note. More...

#include <BdsD.h>

Inheritance diagram for Bds::Note:
BObj

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)
 
- Public Member Functions inherited from BObj
 BObj ()
 
virtual ~BObj ()
 
virtual const char * getType () const
 
virtual const BObjMembergetMembers () 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...
 

Detailed Description

This holds information on a Note.

Constructor & Destructor Documentation

◆ Note()

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

Member Function Documentation

◆ getMember()

BError Bds::Note::getMember ( BString  name,
BString value 
)
virtual

Reimplemented from BObj.

◆ getMembers()

BError Bds::Note::getMembers ( BDictString members)
virtual

Reimplemented from BObj.

◆ getType()

BString Bds::Note::getType ( )

◆ setMember()

BError Bds::Note::setMember ( BString  name,
BString  value 
)
virtual

Reimplemented from BObj.

◆ setMembers()

BError Bds::Note::setMembers ( BDictString members)
virtual

Reimplemented from BObj.

Member Data Documentation

◆ channel

BString Bds::Note::channel

The Channels name.

◆ dataFileId

BUInt32 Bds::Note::dataFileId

The data file id associated with this note.

◆ description

BString Bds::Note::description

The Description.

◆ docFormat

BString Bds::Note::docFormat

Document format if any.

◆ docUrl

BString Bds::Note::docUrl

Document Url if any.

◆ endTime

BTimeStamp Bds::Note::endTime

The End Time note is for.

◆ errorNumber

BInt32 Bds::Note::errorNumber

Error number if error.

◆ id

BUInt32 Bds::Note::id

The unique id.

◆ importFilename

BString Bds::Note::importFilename

The import filename.

◆ network

BString Bds::Note::network

The Network Name.

◆ source

BString Bds::Note::source

The Data Source.

◆ startTime

BTimeStamp Bds::Note::startTime

The Start Time note is for.

◆ station

BString Bds::Note::station

The Station/Array name.

◆ timeAdded

BTimeStamp Bds::Note::timeAdded

The Time Entered.

◆ title

BString Bds::Note::title

The title.

◆ type

BString Bds::Note::type

The Type (note, warning, error ...)

◆ user

BString Bds::Note::user

The user.


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