Bds::DataAccess Class Reference

#include <BdsC.h>

List of all members.

Public Member Functions

 DataAccess (BString name="")
BError connect (BString user, BString password)
 Provides user/password information for secure connection.
BError validateUser (BString user, BString email)
 Checks the user given name or email.
BError setUser (BString user, BString email)
 Sets user to given name or email.
BError setUserReal ()
 Sets user back to real user.
BError getVersion (BString &version)
 Gets the software version.
BError userGetGroups (BList< BString > &groups)
BError networkGetList (BList< Network > &networks)
 Get list of groups the user belongs to Get list of Networks.
BError stationGetList (Selection sel, BList< Station > &stations)
 Get list of Stations.
BError channelGetList (Selection sel, BList< Channel > &channels)
 Get list of Channels.
BError sourceGetList (BList< Source > &sources)
 Get list of Sources.
BError sourcePriorityGetList (BList< SourcePriority > &sourcePrioritys)
 Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities.
BError dataFileGetList (Selection sel, BList< DataFileInfo > &dataFile)
 Get list of DataFiles.
BError dataChannelGetList (Selection sel, BList< DataChannel > &dataChannel)
 Get list of DataChannels.
BError getSelectionInfo (SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
 Get selection info.
BError getSelections (SelectionGroup group, Selection selectionIn, Selection &selectionOut)
 Get selection list.
BError dataSearch (Selection selection, DataInfo &dataInfo)
 Search for data matching the given selection parameters.
BError dataGetChannelInfo (DataInfo dataInfo, ChannelInfos &channelInfos)
 Return the channel MetaData in structured form.
BError dataOpen (DataInfo dataInfo, BString mode, BString format, DataHandle &dataHandle)
 Open a data stream.
BError dataGetInfo (DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
 Get information on the data stream.
BError dataGetWarnings (DataHandle dataHandle, BList< BString > &warnings)
 Get information on the data stream.
BError dataSeekBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
 Searches for a data block matching the time given.
BError dataGetBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
 Return a block of data.
BError dataClose (DataHandle dataHandle)
 Close a stream.
BError dataFormattedRead (DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
 Read the raw data from the stream.
BError dataFormattedGetLength (DataHandle dataHandle, BUInt64 &length)
 Read the raw data from the stream.
BError noteUpdate (BInt32 append, Note note, BUInt32 &id)
BError modeSet (Mode mode, Mode &previousMode)
 Changes the system mode from Master to slave.
BError modeSnapshotPause (BInt32 on)
 Enables/disables backup synchronisation pause.
BError statisticsGet (BDict< BString > &info)
BError dataFormatGetList (BList< DataFormat > &formats)
 Get list of data formats.


Detailed Description

This class defines a TimePeriod This class defines a Network organisation. Could have other information here like website, contacts etc This class defines a Source This class defines a Source Order entry This class defines an arrays channel This class defines a Location. This will be the stations location. This class defines a Pole/Zero Response This class defines a Amplitude/Phase Response This class defines a Response This class defines a calibration setting This class defines a Digitiser This class defines a Sensor This class defines a Channel to Digitiser/Sensor linkage This class defines a Channel This class defines the set of data selection critera This class provides information on a set of channels This class defines information on a data file This defines a handle to a data stream/file This holds information on a user This holds information on a groups This holds information on data access groups This holds information on a change This holds information on a change This holds information on a Note This holds information on a data format This class defines information on a data channel


Constructor & Destructor Documentation

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


Member Function Documentation

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

Get list of Channels.

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

Provides user/password information for secure connection.

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

Get list of DataChannels.

BError Bds::DataAccess::dataClose ( DataHandle  dataHandle  ) 

Close a stream.

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

Get list of DataFiles.

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

Get list of data formats.

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

Read the raw data from the stream.

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

Read the raw data from the stream.

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

Return a block of data.

BError Bds::DataAccess::dataGetChannelInfo ( DataInfo  dataInfo,
ChannelInfos channelInfos 
)

Return the channel MetaData in structured form.

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

Get information on the data stream.

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

Get information on the data stream.

BError Bds::DataAccess::dataOpen ( DataInfo  dataInfo,
BString  mode,
BString  format,
DataHandle dataHandle 
)

Open a data stream.

BError Bds::DataAccess::dataSearch ( Selection  selection,
DataInfo dataInfo 
)

Search for data matching the given selection parameters.

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

Searches for a data block matching the time given.

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

Get selection info.

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

Get selection list.

BError Bds::DataAccess::getVersion ( BString &  version  ) 

Gets the software version.

BError Bds::DataAccess::modeSet ( Mode  mode,
Mode previousMode 
)

Changes the system mode from Master to slave.

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

Enables/disables backup synchronisation pause.

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

Get list of groups the user belongs to Get list of Networks.

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

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

Sets user to given name or email.

BError Bds::DataAccess::setUserReal (  ) 

Sets user back to real user.

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

Get list of Sources.

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

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

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

Get list of Stations.

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

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

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

Checks the user given name or email.


The documentation for this class was generated from the following files:
Generated on Fri Mar 12 14:00:33 2010 for BdsApi by  doxygen 1.4.7