Bds::Note Class Reference

This holds information on a Note for general information. More...

#include <BdsD.h>

Inheritance diagram for Bds::Note:

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(), BUInt32 eventId=0)
const char *	getType () const
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 BObjMember *	getMembers () const
virtual BError	getMembers (BDictString &members)
virtual BError	getMember (BString name, BString &value)
virtual BError	setMembers (BDictString &members)
virtual BError	setMember (BString name, BString value)
virtual void	membersPrint () const
virtual BString	getDebugString ()

Public Attributes
BUInt32	id
	The unique id.
BTimeStamp	startTime
	The Start Time note is for.
BTimeStamp	endTime
	The End Time note is for.
BString	network
	The Network Name.
BString	station
	The Station/Array name.
BString	channel
	The Channels name.
BString	source
	The Data Source.
BString	type
	The Type (note, warning, error ...)
BString	user
	The user.
BTimeStamp	timeAdded
	The Time Entered.
BInt32	errorNumber
	Error number if error.
BString	title
	The title.
BString	description
	The Description.
BString	docFormat
	Document format if any.
BString	docUrl
	Document Url if any.
BUInt32	dataFileId
	The data file id associated with this note.
BString	importFilename
	The import filename.
BUInt32	eventId
	The event ID associated with this note.

Detailed Description

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 manually by a user. A User can then ask for any notes for a particular set of data.

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(),
		BUInt32	eventId = 0
	)

Member Function Documentation

getType()

const char * Bds::Note::getType ( ) const

virtual

Reimplemented from BObj.

setMembers()

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

virtual

Reimplemented from BObj.

setMember()

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

virtual

Reimplemented from BObj.

getMembers()

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

virtual

Reimplemented from BObj.

getMember()

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

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::Note::id

The unique id.

startTime

BTimeStamp Bds::Note::startTime

The Start Time note is for.

endTime

BTimeStamp Bds::Note::endTime

The End Time note is for.

network

BString Bds::Note::network

The Network Name.

station

BString Bds::Note::station

The Station/Array name.

channel

BString Bds::Note::channel

The Channels name.

source

BString Bds::Note::source

The Data Source.

type

BString Bds::Note::type

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

user

BString Bds::Note::user

The user.

timeAdded

BTimeStamp Bds::Note::timeAdded

The Time Entered.

errorNumber

BInt32 Bds::Note::errorNumber

Error number if error.

title

BString Bds::Note::title

The title.

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.

dataFileId

BUInt32 Bds::Note::dataFileId

The data file id associated with this note.

importFilename

BString Bds::Note::importFilename

The import filename.

eventId

BUInt32 Bds::Note::eventId

The event ID associated with this note.

---

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

• BdsD.h
• BdsD.cc