This is the DataAdd Access API interface. More...

#include <BdsC.h>

Inheritance diagram for Bds::DataAddAccess:

Public Member Functions
	DataAddAccess (BString name="")

BError	connect (BString user, BString password)
	Provides user/password information. More...

BError	validateUser (BString user, BString email)
	Checks the user given name or email. More...

BError	setUser (BString user, BString email)
	Sets user to given name or email. More...

BError	setUserReal ()
	Sets user back to real user. More...

BError	getVersion (BString &version, BString &name)
	Gets the software version and server name. More...

BError	userGetFromId (BUInt32 id, User &user)

BError	userGet (User &user)
	Get user info given user ID. More...

BError	userSet (User user)
	Get user info. More...

BError	userGetGroups (BList< BString > &groups)
	Set user info. More...

BError	groupGetList (BList< Group > &groups)
	Get list of groups the user belongs to. More...

BError	networkGetList (BList< Network > &networks)
	Get list of Networks. More...

BError	stationGetList (Selection sel, BList< Station > &stations)
	Get list of Stations. More...

BError	channelGetList (Selection sel, BList< Channel > &channels)
	Get list of Channels. More...

BError	sourceGetList (BList< Source > &sources)
	Get list of Sources. More...

BError	sourcePriorityGetList (BList< SourcePriority > &sourcePrioritys)
	Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities. More...

BError	dataFileGetList (Selection sel, BList< DataFileInfo > &dataFile)
	Get list of DataFiles. More...

BError	dataChannelGetList (Selection sel, BList< DataChannel > &dataChannel)
	Get list of DataChannels. More...

BError	channelInstrumentGetList (Selection sel, BList< ChannelInstrument > &channelInstruments)
	Get list of Channel Instruments. More...

BError	digitiserGetList (Selection sel, BList< Digitiser > &digitisers)
	Get list of Channels. More...

BError	digitiserGet (BUInt32 id, Digitiser &digitiser)

BError	sensorGetList (Selection sel, BList< Sensor > &sensors)
	Get list of Channels. More...

BError	sensorGet (BUInt32 id, Sensor &sensor)

BError	calibrationGetList (Selection sel, BList< Calibration > &calibrations)
	Get list of Channels. More...

BError	responseGetList (Selection sel, BList< Response > &responses)
	Get list of Channels. More...

BError	locationGetList (Selection sel, BList< Location > &locations)
	Get list of Station Locations. More...

BError	getSelectionInfo (SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
	Get selection info. More...

BError	getSelections (SelectionGroup group, Selection selectionIn, Selection &selectionOut)
	Get selection list. More...

BError	dataSearch (Selection selection, DataInfo &dataInfo)
	Search for data matching the given selection parameters. More...

BError	dataGetChannelInfo (DataInfo dataInfo, ChannelInfos &channelInfos)
	Return the channel MetaData in structured form. More...

BError	dataOpen (DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
	Open a data stream. More...

BError	dataGetInfo (DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
	Get information on the data stream. More...

BError	dataGetNotes (DataHandle dataHandle, BList< Note > &notes)
	Get notes on the data stream. More...

BError	dataGetWarnings (DataHandle dataHandle, BList< BString > &warnings)
	Get information on the data stream. More...

BError	dataSeekBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
	Searches for a data block matching the time given. More...

BError	dataGetBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
	Return a block of data. More...

BError	dataSetInfo (DataHandle dataHandle, DataInfo dataInfo)
	Set the info when writing to a stream. More...

BError	dataPutBlock (DataHandle dataHandle, DataBlock data)
	Send a block of data. More...

BError	dataClose (DataHandle dataHandle, BError error, BInt32 del)
	Close a stream. More...

BError	dataFormattedRead (DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
	Read the raw data from the stream. More...

BError	dataFormattedGetLength (DataHandle dataHandle, BUInt64 &length)
	The total length in bytes of the formated data. More...

BError	noteGetList (Selection sel, BList< Note > &notes)

BError	noteUpdate (BInt32 append, Note note, BUInt32 &id)

BError	noteWriteDocument (BUInt32 id, BString format, BArray< BUInt8 > data)

BError	noteReadDocument (BUInt32 id, BString &format, BArray< BUInt8 > &data)

BError	logUpdate (BInt32 append, Log log, BUInt32 &id)
	Append a log item. More...

BError	logAppend (BString type, BUInt32 priority, BString subSystem, BString title, BString description)
	Append a log item. More...

BError	modeSet (Mode mode, Mode &previousMode)
	Changes the system mode from Master to slave. More...

BError	modeSnapshotPause (BInt32 on)
	Enables/disables backup synchronisation pause. More...

BError	clean (CleanOptions cleanOptions)
	Cleans the system logs and Changes information. More...

BError	databaseBackup (BString &ref)
	Backup the database. More...

BError	statisticsGet (BDict< BString > &info)

BError	dataFormatGetList (BList< DataFormat > &formats)
	Get list of data formats. More...

Detailed Description

This is the DataAdd Access API interface.

Constructor & Destructor Documentation

Bds::DataAddAccess::DataAddAccess ( BString name = "" )

Member Function Documentation

BError Bds::DataAddAccess::calibrationGetList	(	Selection	sel,
		BList< Calibration > &	calibrations
	)

Get list of Channels.

BError Bds::DataAddAccess::channelGetList	(	Selection	sel,
		BList< Channel > &	channels
	)

Get list of Channels.

BError Bds::DataAddAccess::channelInstrumentGetList	(	Selection	sel,
		BList< ChannelInstrument > &	channelInstruments
	)

Get list of Channel Instruments.

BError Bds::DataAddAccess::clean ( CleanOptions cleanOptions )

Cleans the system logs and Changes information.

BError Bds::DataAddAccess::connect	(	BString	user,
		BString	password
	)

Provides user/password information.

BError Bds::DataAddAccess::databaseBackup ( BString & ref )

Backup the database.

BError Bds::DataAddAccess::dataChannelGetList	(	Selection	sel,
		BList< DataChannel > &	dataChannel
	)

Get list of DataChannels.

BError Bds::DataAddAccess::dataClose	(	DataHandle	dataHandle,
		BError	error,
		BInt32	del
	)

Close a stream.

BError Bds::DataAddAccess::dataFileGetList	(	Selection	sel,
		BList< DataFileInfo > &	dataFile
	)

Get list of DataFiles.

BError Bds::DataAddAccess::dataFormatGetList ( BList< DataFormat > & formats )

Get list of data formats.

BError Bds::DataAddAccess::dataFormattedGetLength	(	DataHandle	dataHandle,
		BUInt64 &	length
	)

The total length in bytes of the formated data.

BError Bds::DataAddAccess::dataFormattedRead	(	DataHandle	dataHandle,
		BUInt32	number,
		BArray< BUInt8 > &	data
	)

Read the raw data from the stream.

BError Bds::DataAddAccess::dataGetBlock	(	DataHandle	dataHandle,
		BUInt32	channel,
		BUInt32	segment,
		BUInt32	blockNumber,
		DataBlock &	data
	)

Return a block of data.

BError Bds::DataAddAccess::dataGetChannelInfo	(	DataInfo	dataInfo,
		ChannelInfos &	channelInfos
	)

Return the channel MetaData in structured form.

BError Bds::DataAddAccess::dataGetInfo	(	DataHandle	dataHandle,
		BUInt32	infoExtra,
		DataInfo &	dataInfo
	)

Get information on the data stream.

BError Bds::DataAddAccess::dataGetNotes	(	DataHandle	dataHandle,
		BList< Note > &	notes
	)

Get notes on the data stream.

BError Bds::DataAddAccess::dataGetWarnings	(	DataHandle	dataHandle,
		BList< BString > &	warnings
	)

Get information on the data stream.

BError Bds::DataAddAccess::dataOpen	(	DataInfo	dataInfo,
		BString	mode,
		BString	format,
		BUInt32	flags,
		DataHandle &	dataHandle
	)

Open a data stream.

BError Bds::DataAddAccess::dataPutBlock	(	DataHandle	dataHandle,
		DataBlock	data
	)

Send a block of data.

BError Bds::DataAddAccess::dataSearch	(	Selection	selection,
		DataInfo &	dataInfo
	)

Search for data matching the given selection parameters.

BError Bds::DataAddAccess::dataSeekBlock	(	DataHandle	dataHandle,
		BUInt32	channel,
		BUInt32	segment,
		BTimeStamp	time,
		BUInt32 &	blockNumber
	)

Searches for a data block matching the time given.

BError Bds::DataAddAccess::dataSetInfo	(	DataHandle	dataHandle,
		DataInfo	dataInfo
	)

Set the info when writing to a stream.

BError Bds::DataAddAccess::digitiserGet	(	BUInt32	id,
		Digitiser &	digitiser
	)

BError Bds::DataAddAccess::digitiserGetList	(	Selection	sel,
		BList< Digitiser > &	digitisers
	)

Get list of Channels.

BError Bds::DataAddAccess::getSelectionInfo	(	SelectionGroup	group,
		Selection	selectionIn,
		SelectionInfo &	selectionInfo
	)

Get selection info.

BError Bds::DataAddAccess::getSelections	(	SelectionGroup	group,
		Selection	selectionIn,
		Selection &	selectionOut
	)

Get selection list.

BError Bds::DataAddAccess::getVersion	(	BString &	version,
		BString &	name
	)

Gets the software version and server name.

BError Bds::DataAddAccess::groupGetList ( BList< Group > & groups )

Get list of groups the user belongs to.

Get list of Groups

BError Bds::DataAddAccess::locationGetList	(	Selection	sel,
		BList< Location > &	locations
	)

Get list of Station Locations.

BError Bds::DataAddAccess::logAppend	(	BString	type,
		BUInt32	priority,
		BString	subSystem,
		BString	title,
		BString	description
	)

Append a log item.

BError Bds::DataAddAccess::logUpdate	(	BInt32	append,
		Log	log,
		BUInt32 &	id
	)

Append a log item.

BError Bds::DataAddAccess::modeSet	(	Mode	mode,
		Mode &	previousMode
	)

Changes the system mode from Master to slave.

BError Bds::DataAddAccess::modeSnapshotPause ( BInt32 on )

Enables/disables backup synchronisation pause.

BError Bds::DataAddAccess::networkGetList ( BList< Network > & networks )

Get list of Networks.

BError Bds::DataAddAccess::noteGetList	(	Selection	sel,
		BList< Note > &	notes
	)

BError Bds::DataAddAccess::noteReadDocument	(	BUInt32	id,
		BString &	format,
		BArray< BUInt8 > &	data
	)

BError Bds::DataAddAccess::noteUpdate	(	BInt32	append,
		Note	note,
		BUInt32 &	id
	)

BError Bds::DataAddAccess::noteWriteDocument	(	BUInt32	id,
		BString	format,
		BArray< BUInt8 >	data
	)

BError Bds::DataAddAccess::responseGetList	(	Selection	sel,
		BList< Response > &	responses
	)

Get list of Channels.

BError Bds::DataAddAccess::sensorGet	(	BUInt32	id,
		Sensor &	sensor
	)

BError Bds::DataAddAccess::sensorGetList	(	Selection	sel,
		BList< Sensor > &	sensors
	)

Get list of Channels.

BError Bds::DataAddAccess::setUser	(	BString	user,
		BString	email
	)

Sets user to given name or email.

BError Bds::DataAddAccess::setUserReal ( )

Sets user back to real user.

BError Bds::DataAddAccess::sourceGetList ( BList< Source > & sources )

Get list of Sources.

BError Bds::DataAddAccess::sourcePriorityGetList ( BList< SourcePriority > & sourcePrioritys )

Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities.

BError Bds::DataAddAccess::stationGetList	(	Selection	sel,
		BList< Station > &	stations
	)

Get list of Stations.

BError Bds::DataAddAccess::statisticsGet ( BDict< BString > & info )

BError Bds::DataAddAccess::userGet ( User & user )

Get user info given user ID.

BError Bds::DataAddAccess::userGetFromId	(	BUInt32	id,
		User &	user
	)

BError Bds::DataAddAccess::userGetGroups ( BList< BString > & groups )

Set user info.

BError Bds::DataAddAccess::userSet ( User user )

Get user info.

BError Bds::DataAddAccess::validateUser	(	BString	user,
		BString	email
	)

Checks the user given name or email.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation