BdsApi  2.2.5
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
BdsC.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * BdsC.h Produced by Bidl
3  *******************************************************************************
4  */
5 
6 #ifndef BDSC_H
7 #define BDSC_H 1
8 
9 #include <stdlib.h>
10 #include <stdint.h>
11 #include <Boap.h>
12 #include <BString.h>
13 #include <BList.h>
14 #include <BArray.h>
15 #include <BdsD.h>
16 
17 
18 namespace Bds {
19  const BUInt32 apiVersion = 0;
20 
25 
26  class DataAccess : public BoapClientObject {
27  public:
28  DataAccess(BString name = "");
29  BError connect(BString user, BString password);
30  BError validateUser(BString user, BString email);
31  BError setUser(BString user, BString email);
33  BError getVersion(BString& version, BString& name);
34  // Information functions
35  BError userGetFromId(BUInt32 id, User& user);
36  BError userGet(User& user);
37  BError userSet(User user);
49  BError digitiserGet(BUInt32 id, Digitiser& digitiser);
51  BError sensorGet(BUInt32 id, Sensor& sensor);
55  // Selections
56  BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
57  BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
58  BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
59  BError dataSearch(Selection selection, DataInfo& dataInfo);
60  BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
61  BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
62  BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
63  BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
64  BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
65  BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
66  BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
67  BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
71  BError noteUpdate(BInt32 append, Note note, BUInt32& id);
74  BError logUpdate(BInt32 append, Log log, BUInt32& id);
75  BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
76  // Management functions
77  BError modeSet(Mode mode, Mode& previousMode);
79  BError clean(CleanOptions cleanOptions);
81  // Information functions
84  private:
85  };
92  public:
93  DataAddAccess(BString name = "");
94  BError connect(BString user, BString password);
95  BError validateUser(BString user, BString email);
96  BError setUser(BString user, BString email);
98  BError getVersion(BString& version, BString& name);
99  // Information functions
100  BError userGetFromId(BUInt32 id, User& user);
101  BError userGet(User& user);
102  BError userSet(User user);
114  BError digitiserGet(BUInt32 id, Digitiser& digitiser);
116  BError sensorGet(BUInt32 id, Sensor& sensor);
120  // Selections
121  BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
122  BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
123  BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
124  BError dataSearch(Selection selection, DataInfo& dataInfo);
125  BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
126  BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
127  BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
128  BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
129  BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
130  BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
131  BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
132  BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);
133  BError dataPutBlock(DataHandle dataHandle, DataBlock data);
134  BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
138  BError noteUpdate(BInt32 append, Note note, BUInt32& id);
141  BError logUpdate(BInt32 append, Log log, BUInt32& id);
142  BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
143  // Management functions
144  BError modeSet(Mode mode, Mode& previousMode);
146  BError clean(CleanOptions cleanOptions);
148  // Information functions
151  private:
152  };
157  class AdminAccess : public BoapClientObject {
158  public:
159  AdminAccess(BString name = "");
160  BError connect(BString user, BString password);
161  BError validateUser(BString user, BString email);
162  BError setUser(BString user, BString email);
163  BError setUserReal();
164  BError getVersion(BString& version, BString& name);
165  // User functions
167  BError userUpdate(BInt32 append, User user, BUInt32& id);
169  BError userGetFromId(BUInt32 id, User& user);
170  BError userGet(User& user);
171  BError userSet(User user);
174  BError groupUpdate(BInt32 append, Group group, BUInt32& id);
177  BError accessGroupUpdate(BInt32 append, AccessGroup group, BUInt32& id);
179  // Selections
180  BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
181  BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
183  BError networkUpdate(BInt32 append, Network network, BUInt32& id);
186  BError stationUpdate(BInt32 append, Station station, BUInt32& id);
189  BError locationUpdate(BInt32 append, Location location, BUInt32& id);
192  BError channelGet(BUInt32 id, Channel& channel);
193  BError channelUpdate(BInt32 append, Channel channel, BUInt32& id);
196  BError sourceUpdate(BInt32 append, Source source, BUInt32& id);
199  BError sourcePriorityUpdate(BInt32 append, SourcePriority sourcePriority, BUInt32& id);
202  BError channelInstrumentUpdate(BInt32 append, ChannelInstrument channelInstrument, BUInt32& id);
205  BError digitiserGet(BUInt32 id, Digitiser& digitiser);
206  BError digitiserUpdate(BInt32 append, Digitiser digitiser, BUInt32& id);
209  BError sensorGet(BUInt32 id, Sensor& sensor);
210  BError sensorUpdate(BInt32 append, Sensor sensor, BUInt32& id);
213  BError calibrationUpdate(BInt32 append, Calibration calibration, BUInt32& id);
216  BError responseUpdate(BInt32 append, Response response, BUInt32& id);
219  BError dataFileUpdate(BInt32 append, DataFileInfo dataFile, BUInt32& id);
222  BError dataChannelUpdate(BInt32 append, DataChannel dataChannel, BUInt32& id);
224  BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
225  BError dataSearch(Selection selection, DataInfo& dataInfo);
226  BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
227  BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
228  BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
229  BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
230  BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
231  BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
232  BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
233  BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);
234  BError dataPutBlock(DataHandle dataHandle, DataBlock data);
235  BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
238  // Change/Logging functions
239  BError changeGroupStart(ChangeGroup changeGroup);
242  BError changeGroupDelete(BTimeStamp beforeDate, BString type, BInt32 empty);
244  BError changeGetList(BUInt32 id, ListRange range, BList<Change >& changes);
245  BError changeDelete(BTimeStamp beforeDate, BString type);
247  BError noteUpdate(BInt32 append, Note note, BUInt32& id);
251  BError logGetList(LogSelect sel, BList<Log >& logs);
252  BError logUpdate(BInt32 append, Log log, BUInt32& id);
253  BError logDelete(BUInt32 id);
254  BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
255  // Information functions
258  // Management functions
260  BError transactionEnd(BInt32 abort);
261  BError modeSet(Mode mode, Mode& previousMode);
263  BError clean(CleanOptions cleanOptions);
266  // Low level functions
267  BError sqlQuery(BString query, BList<BDict<BString > >& result);
268  private:
269  };
270 }
271 #endif
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters.
Definition: BdsC.cc:4525
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:8080
BError groupUpdate(BInt32 append, Group group, BUInt32 &id)
Update or append a group entry.
Definition: BdsC.cc:6613
BError networkUpdate(BInt32 append, Network network, BUInt32 &id)
Add or update a Network entry.
Definition: BdsC.cc:7023
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:8764
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:8260
This class defines a generic metadata or seismic data selection.
Definition: BdsD.h:453
BError digitiserDelete(BUInt32 id)
Delete a Digitiser entry.
Definition: BdsC.cc:8051
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:5767
BError userDelete(BUInt32 id)
Delete a user entry.
Definition: BdsC.cc:6370
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:7970
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:7092
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:7662
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of data formats.
Definition: BdsC.cc:2938
This class defines information on a single channels set of data stored in a file. ...
Definition: BdsD.h:535
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:9773
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
Read the raw data from the file.
Definition: BdsC.cc:2485
BError changeGroupStart(ChangeGroup changeGroup)
Start a new ChangeGroup when making a set of changes to the BDS&#39;s database.
Definition: BdsC.cc:10053
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:10908
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the file.
Definition: BdsC.cc:9985
BError dataPutBlock(DataHandle dataHandle, DataBlock data)
Send a block of data.
Definition: BdsC.cc:5492
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:5997
BError dataPutBlock(DataHandle dataHandle, DataBlock data)
Send a block of data.
Definition: BdsC.cc:9901
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of supported data formats.
Definition: BdsC.cc:10708
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:6897
This defines a handle to a sensor data stream/file when opened for read or write. ...
Definition: BdsD.h:617
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:4449
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:9012
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:5937
BError noteGetList(Selection sel, BList< Note > &notes)
Return a list of Notes.
Definition: BdsC.cc:2516
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:3926
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:9497
BError userSet(User user)
Set user info.
Definition: BdsC.cc:253
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:3966
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:3084
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:3592
This class defines a seismic Digitiser.
Definition: BdsD.h:324
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:944
BOAP data class definitions for: Bds.
BError locationUpdate(BInt32 append, Location location, BUInt32 &id)
Add or update a Station Location entry.
Definition: BdsC.cc:7309
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:6399
BError connect(BString user, BString password)
Provides user/password information for secure connection.
Definition: BdsC.cc:12
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:9613
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:2639
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Add or update a Log item.
Definition: BdsC.cc:2709
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Channel Instruments.
Definition: BdsC.cc:7768
BError responseUpdate(BInt32 append, Response response, BUInt32 &id)
Add or update a Response entry.
Definition: BdsC.cc:8523
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:2318
This class defines a seismic Sensor.
Definition: BdsD.h:348
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:296
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:4603
BError accessGroupUpdate(BInt32 append, AccessGroup group, BUInt32 &id)
Update or append an AccessGroup entry.
Definition: BdsC.cc:6718
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:10485
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:1054
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:10848
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:9953
BError calibrationDelete(BUInt32 id)
Delete a Calibration entry.
Definition: BdsC.cc:8379
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:610
BError sourceUpdate(BInt32 append, Source source, BUInt32 &id)
Add or update a Source entry.
Definition: BdsC.cc:7598
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:5966
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:42
uint64_t BUInt64
This class defines a seismic Response characteristic.
Definition: BdsD.h:266
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the file.
Definition: BdsC.cc:2448
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:5801
BError changeGroupDelete(BTimeStamp beforeDate, BString type, BInt32 empty)
Delete a ChangeGroup.
Definition: BdsC.cc:10161
BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo)
Set the info when writing to a file.
Definition: BdsC.cc:9807
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:3356
BError sensorUpdate(BInt32 append, Sensor sensor, BUInt32 &id)
Add or update a Sensor entry.
Definition: BdsC.cc:8190
BError userGet(User &user)
Get user info.
Definition: BdsC.cc:207
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:3703
BError responseDelete(BUInt32 id)
Delete a Response entry.
Definition: BdsC.cc:8597
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:5260
This class defines information on a set of data.
Definition: BdsD.h:570
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:102
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Channels.
Definition: BdsC.cc:3856
BError userSet(User user)
Set user info.
Definition: BdsC.cc:3235
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:2809
BError changeDelete(BTimeStamp beforeDate, BString type)
Delete a Change.
Definition: BdsC.cc:10269
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responces.
Definition: BdsC.cc:1168
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters.
Definition: BdsC.cc:8934
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:6240
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:2838
BError userSet(User user)
Set user info.
Definition: BdsC.cc:6492
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:9400
This class defines information on a sensor data file.
Definition: BdsD.h:507
This holds information on a set of Changes.
Definition: BdsD.h:733
BError userGet(User &user)
Get user info.
Definition: BdsC.cc:3189
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:2746
BError channelUpdate(BInt32 append, Channel channel, BUInt32 &id)
Add or update a Channel entry.
Definition: BdsC.cc:7487
This class provides the acual seismic data values contained within a single data block.
Definition: BdsD.h:637
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:10818
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:10375
Mode
BdsServer mode.
Definition: BdsD.h:35
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:9669
BUInt32 format
This holds information on a user security group.
Definition: BdsD.h:674
BError sourcePriorityDelete(BUInt32 id)
Definition: BdsC.cc:7739
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:130
This defines the selection cirteria when requesting a set of log entries.
Definition: BdsD.h:804
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:1756
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:5300
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:3278
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station Locations.
Definition: BdsC.cc:1283
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:5907
BError digitiserUpdate(BInt32 append, Digitiser digitiser, BUInt32 &id)
Add or update a Digitiser entry.
Definition: BdsC.cc:8010
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:2898
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
Read the raw data from the file.
Definition: BdsC.cc:10022
This class defines an integer based range.
Definition: BdsD.h:76
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:2222
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:3142
This is the AdminAccess Access API interface.
Definition: BdsC.h:157
This class provides metadata information on a set of channels.
Definition: BdsD.h:496
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
The total length in bytes of the formated data.
Definition: BdsC.cc:5613
BError channelInstrumentDelete(BUInt32 id)
Delete an Instrument entry.
Definition: BdsC.cc:7871
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:2673
This class defines the set of metadata or siesmic data selected when getSelectionInfo() is use...
Definition: BdsD.h:420
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:4738
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the stream.
Definition: BdsC.cc:5576
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station Locations.
Definition: BdsC.cc:4265
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:3634
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:9147
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Add or Update a Log item.
Definition: BdsC.cc:10569
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:10635
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:2779
BError changeGroupEnd()
End a ChangeGroup.
Definition: BdsC.cc:10087
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:499
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Append a log item ///&lt; Add or update a Log item.
Definition: BdsC.cc:5837
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:424
BError calibrationUpdate(BInt32 append, Calibration calibration, BUInt32 &id)
Add or update a Calibration entry.
Definition: BdsC.cc:8334
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:6026
BError setUser(BString user, BString email)
Sets user to given name or email.
Definition: BdsC.cc:3054
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:5874
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:6152
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:721
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:374
int32_t BInt32
BError dataFileDelete(BUInt32 id)
Delete a DataFile entry.
Definition: BdsC.cc:8735
BError accessGroupGetList(BList< AccessGroup > &accessGroups)
Get list of AccessGroups.
Definition: BdsC.cc:6675
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:1467
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:7556
BError noteGetList(Selection sel, BList< Note > &notes)
Get a list of Notes.
Definition: BdsC.cc:10299
const BUInt32 apiVersion
Definition: BdsC.h:19
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:984
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:160
BError groupGetList(BList< Group > &groups)
Get list of Groups.
Definition: BdsC.cc:334
uint32_t BUInt32
BError groupGetList(BList< Group > &groups)
Get list of Groups.
Definition: BdsC.cc:3316
This class defines a seismic Network organisation.
Definition: BdsD.h:92
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:3406
BError setUser(BString user, BString email)
Sets user to given name or email.
Definition: BdsC.cc:6182
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Digitisers.
Definition: BdsC.cc:874
This class defines a Channel&#39;s instrument.
Definition: BdsD.h:374
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:568
BError changeGetListNumber(BUInt32 id, BUInt32 &number)
Get the number of changes in a ChangeGroup.
Definition: BdsC.cc:10192
BError transactionStart()
Starts a set of transactions.
Definition: BdsC.cc:10761
BError groupDelete(BUInt32 id)
Delete a group entry.
Definition: BdsC.cc:6646
This holds information on data access groups.
Definition: BdsD.h:691
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station Locations.
Definition: BdsC.cc:7239
This class defines a seismic station.
Definition: BdsD.h:178
DataAddAccess(BString name="")
Definition: BdsC.cc:2991
This class defines the physical location of a Station.
Definition: BdsD.h:193
BError setUser(BString user, BString email)
Sets user to given name or email.
Definition: BdsC.cc:72
BError groupGetList(BList< Group > &groups)
Get list of Groups.
Definition: BdsC.cc:6573
BError stationDelete(BUInt32 id)
Delete a Station entry.
Definition: BdsC.cc:7210
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:2416
BError transactionEnd(BInt32 abort)
Ends a set of transactions.
Definition: BdsC.cc:10789
BError accessGroupDelete(BUInt32 id)
Delete an AccessGroup entry.
Definition: BdsC.cc:6754
char data[8]
BError stationUpdate(BInt32 append, Station station, BUInt32 &id)
Add or update a Station entry.
Definition: BdsC.cc:7167
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:3112
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:2352
BError locationDelete(BUInt32 id)
Delete a Station Location entry.
Definition: BdsC.cc:7350
BError sourcePriorityUpdate(BInt32 append, SourcePriority sourcePriority, BUInt32 &id)
Definition: BdsC.cc:7704
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Instruments.
Definition: BdsC.cc:808
This class defines a seismic data Source.
Definition: BdsD.h:112
This is the Data Access API interface.
Definition: BdsC.h:26
BError channelInstrumentUpdate(BInt32 append, ChannelInstrument channelInstrument, BUInt32 &id)
Add or update a Instrument entry.
Definition: BdsC.cc:7834
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:9709
This class defines a Source Priority entry.
Definition: BdsD.h:132
BError changeGetList(BUInt32 id, ListRange range, BList< Change > &changes)
Get a list of Changes.
Definition: BdsC.cc:10222
BError userUpdate(BInt32 append, User user, BUInt32 &id)
Update or append a user entry.
Definition: BdsC.cc:6325
DataAccess(BString name="")
Definition: BdsC.cc:9
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:5720
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:5544
BInt16 number
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:10877
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:8626
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:652
This class defines a calibration setting.
Definition: BdsD.h:296
BError dataChannelUpdate(BInt32 append, DataChannel dataChannel, BUInt32 &id)
Add or update a DataChannel entry.
Definition: BdsC.cc:8851
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responses.
Definition: BdsC.cc:4150
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:2278
BError userGetList(BList< User > &users)
Get list of Users.
Definition: BdsC.cc:6270
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:2592
BError dataFileUpdate(BInt32 append, DataFileInfo dataFile, BUInt32 &id)
Add or update a DataFile entry.
Definition: BdsC.cc:8695
AdminAccess(BString name="")
Definition: BdsC.cc:6119
This is the DataAdd Access API interface.
Definition: BdsC.h:91
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:10451
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:1353
BError userGet(User &user)
Get user info.
Definition: BdsC.cc:6446
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:3481
BError channelGet(BUInt32 id, Channel &channel)
Get a channel.
Definition: BdsC.cc:7448
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:10668
BError sensorDelete(BUInt32 id)
Delete a Sensor entry.
Definition: BdsC.cc:8231
BError databaseRestore(BString ref, BString type)
Restore the database.
Definition: BdsC.cc:10937
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:6535
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:5088
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Digitisers.
Definition: BdsC.cc:7900
This class defines a seismic data Channel.
Definition: BdsD.h:397
BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo)
Set the info when writing to a file.
Definition: BdsC.cc:5398
This holds information on a Log entry.
Definition: BdsD.h:785
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:3550
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:2106
BError networkDelete(BUInt32 id)
Delete a Network entry.
Definition: BdsC.cc:7063
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:6783
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of data formats.
Definition: BdsC.cc:6066
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:1094
This holds information on a Note for general information.
Definition: BdsD.h:754
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:3024
BError sqlQuery(BString query, BList< BDict< BString > > &result)
A low level SQL access function.
Definition: BdsC.cc:10967
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:4991
BError sourceDelete(BUInt32 id)
Delete a Source entry.
Definition: BdsC.cc:7633
BError channelDelete(BUInt32 id)
Delete a Channel entry.
Definition: BdsC.cc:7527
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:6973
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:5334
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:4036
BUInt32 length
SelectionGroup
The Selection group when making selections.
Definition: BdsD.h:41
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:4335
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters.
Definition: BdsC.cc:1543
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:5204
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:1621
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responses.
Definition: BdsC.cc:8408
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:6212
BError dataChannelDelete(BUInt32 id)
Delete a DataChannel entry.
Definition: BdsC.cc:8905
BUInt16 error
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Instruments.
Definition: BdsC.cc:3790
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:2869
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:7379
This defines the set of clean options used in the clean() function.
Definition: BdsD.h:815
BError connect(BString user, BString password)
Provides user/password information.
Definition: BdsC.cc:6122
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:2009
BError noteDelete(BUInt32 id)
Delete a Note.
Definition: BdsC.cc:10422
BError logGetList(LogSelect sel, BList< Log > &logs)
Get list of log entries.
Definition: BdsC.cc:10521
BError changeGroupGetList(ListRange range, BList< ChangeGroup > &changeGroups)
Return a list of ChangeGroups.
Definition: BdsC.cc:10115
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:8150
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:4076
BError connect(BString user, BString password)
Provides user/password information.
Definition: BdsC.cc:2994
BError logDelete(BUInt32 id)
Delete a Log item.
Definition: BdsC.cc:10606
BError noteGetList(Selection sel, BList< Note > &notes)
Return a list of Notes.
Definition: BdsC.cc:5644
This holds information on a user.
Definition: BdsD.h:651