BdsApi 3.1.4
This is the Blacknest BDS API.
Loading...
Searching...
No Matches
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
18namespace Bds {
20
25
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 // User functions
35 BError userGetFromId(BUInt32 id, User& user);
36 BError userGet(User& user);
37 BError userSet(User user);
42 // Information functions
52 BError digitiserGet(BUInt32 id, Digitiser& digitiser);
54 BError sensorGet(BUInt32 id, Sensor& sensor);
62 // Selections
63 BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
64 BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
65 // Data access functions
66 BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
67 BError dataSearch(Selection selection, DataInfo& dataInfo);
68 BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
69 BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
70 BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
71 BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
72 BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
73 BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
74 BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
75 BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
78 // Real-time data functions
80 BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);
82 BError noteUpdate(BInt32 append, Note note, BUInt32& id);
85 BError logUpdate(BInt32 append, Log log, BUInt32& id);
86 BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
87 // Management functions
88 BError modeSet(Mode mode, Mode& previousMode);
90 BError clean(CleanOptions cleanOptions);
92 // Information functions
96 private:
97 };
104 public:
105 DataAddAccess(BString name = "");
106 BError connect(BString user, BString password);
107 BError validateUser(BString user, BString email);
108 BError setUser(BString user, BString email);
110 BError getVersion(BString& version, BString& name);
111 // User functions
112 BError userGetFromId(BUInt32 id, User& user);
113 BError userGet(User& user);
114 BError userSet(User user);
119 // Information functions
129 BError digitiserGet(BUInt32 id, Digitiser& digitiser);
131 BError sensorGet(BUInt32 id, Sensor& sensor);
136 BError eventUpdate(BInt32 append, Event event, BUInt32& id);
141 // Selections
142 BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
143 BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
144 // Data access functions
145 BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
146 BError dataSearch(Selection selection, DataInfo& dataInfo);
147 BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
148 BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
149 BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
150 BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
151 BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
152 BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
153 BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
154 BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);
156 BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
159 // Real-time data functions
161 BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);
163 BError noteUpdate(BInt32 append, Note note, BUInt32& id);
166 BError logUpdate(BInt32 append, Log log, BUInt32& id);
167 BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
168 // Management functions
169 BError modeSet(Mode mode, Mode& previousMode);
171 BError clean(CleanOptions cleanOptions);
173 // Information functions
177 private:
178 };
184 public:
185 AdminAccess(BString name = "");
186 BError connect(BString user, BString password);
187 BError validateUser(BString user, BString email);
188 BError setUser(BString user, BString email);
190 BError getVersion(BString& version, BString& name);
191 // User functions
193 BError userUpdate(BInt32 append, User user, BUInt32& id);
195 BError userGetFromId(BUInt32 id, User& user);
196 BError userGet(User& user);
197 BError userSet(User user);
202 BError groupUpdate(BInt32 append, Group group, BUInt32& id);
207 // Selections
208 BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo);
209 BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut);
211 BError networkUpdate(BInt32 append, Network network, BUInt32& id);
214 BError stationUpdate(BInt32 append, Station station, BUInt32& id);
217 BError locationUpdate(BInt32 append, Location location, BUInt32& id);
220 BError channelGet(BUInt32 id, Channel& channel);
221 BError channelUpdate(BInt32 append, Channel channel, BUInt32& id);
224 BError sourceUpdate(BInt32 append, Source source, BUInt32& id);
227 BError sourcePriorityUpdate(BInt32 append, SourcePriority sourcePriority, BUInt32& id);
230 BError channelInstrumentUpdate(BInt32 append, ChannelInstrument channelInstrument, BUInt32& id);
233 BError digitiserGet(BUInt32 id, Digitiser& digitiser);
234 BError digitiserUpdate(BInt32 append, Digitiser digitiser, BUInt32& id);
237 BError sensorGet(BUInt32 id, Sensor& sensor);
238 BError sensorUpdate(BInt32 append, Sensor sensor, BUInt32& id);
241 BError calibrationUpdate(BInt32 append, Calibration calibration, BUInt32& id);
244 BError responseUpdate(BInt32 append, Response response, BUInt32& id);
247 BError eventUpdate(BInt32 append, Event event, BUInt32& id);
250 BError specialChannelUpdate(BInt32 append, SpecialChannel specialChannel, BUInt32& id);
254 // Data access functions
256 BError dataFileUpdate(BInt32 append, DataFileInfo dataFile, BUInt32& id);
259 BError dataChannelUpdate(BInt32 append, DataChannel dataChannel, BUInt32& id);
261 BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);
262 BError dataSearch(Selection selection, DataInfo& dataInfo);
263 BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);
264 BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);
265 BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);
266 BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);
267 BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);
268 BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data);
269 BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);
270 BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);
272 BError dataClose(DataHandle dataHandle, BError error, BInt32 del);
275 // Real-time data functions
277 BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);
278 // Change/Logging functions
279 BError changeGroupStart(ChangeGroup changeGroup);
282 BError changeGroupDelete(BTimeStamp beforeDate, BString type, BInt32 empty);
285 BError changeDelete(BTimeStamp beforeDate, BString type);
287 BError noteUpdate(BInt32 append, Note note, BUInt32& id);
292 BError logUpdate(BInt32 append, Log log, BUInt32& id);
294 BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);
295 // Information functions
299 // Management functions
302 BError modeSet(Mode mode, Mode& previousMode);
304 BError clean(CleanOptions cleanOptions);
307 // Low level functions
308 BError sqlQuery(BString query, BList<BDict<BString > >& result);
309 BError extraCall(BUInt32 function, BString args, BString& result);
310 private:
311 };
312}
313#endif
BUInt32 format
BUInt32 length
uint32_t BUInt32
int32_t BInt32
uint64_t BUInt64
BOAP data class definitions for: Bds.
BInt16 number
char data[8]
BUInt16 error
This holds information on data access groups.
Definition: BdsD.h:772
This is the AdminAccess Access API interface.
Definition: BdsC.h:183
BError metadataGetFormatted(Selection sel, BString format, BArray< BUInt8 > &data)
Return the channel MetaData in a particular format.
Definition: BdsC.cc:11478
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:8158
BError locationUpdate(BInt32 append, Location location, BUInt32 &id)
Add or update a Station Location entry.
Definition: BdsC.cc:9434
BError sourcePriorityDelete(BUInt32 id)
Definition: BdsC.cc:9871
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:10410
BError calibrationUpdate(BInt32 append, Calibration calibration, BUInt32 &id)
Add or update a Calibration entry.
Definition: BdsC.cc:10495
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:8989
BError accessGroupGetList(BList< AccessGroup > &accessGroups)
Get list of AccessGroups.
Definition: BdsC.cc:8761
BError logGetList(LogSelect sel, BList< Log > &logs)
Get list of log entries.
Definition: BdsC.cc:13640
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:12964
BError extraCall(BUInt32 function, BString args, BString &result)
A special function to add new functions to the API prior to a full API update.
Definition: BdsC.cc:14176
BError digitiserDelete(BUInt32 id)
Delete a Digitiser entry.
Definition: BdsC.cc:10195
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:12680
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of supported data formats.
Definition: BdsC.cc:13867
BError changeDelete(BTimeStamp beforeDate, BString type)
Delete a Change.
Definition: BdsC.cc:13380
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Channel Instruments.
Definition: BdsC.cc:9900
BError stationUpdate(BInt32 append, Station station, BUInt32 &id)
Add or update a Station entry.
Definition: BdsC.cc:9281
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:9505
BError groupGetList(BList< Group > &groups)
Get list of Groups.
Definition: BdsC.cc:8659
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:9794
BError calibrationDelete(BUInt32 id)
Delete a Calibration entry.
Definition: BdsC.cc:10545
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station, Channel or both Locations depending on the sel.locationSelect parameter.
Definition: BdsC.cc:9357
BError changeGroupDelete(BTimeStamp beforeDate, BString type, BInt32 empty)
Delete a ChangeGroup.
Definition: BdsC.cc:13272
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:14067
BError userDelete(BUInt32 id)
Delete a user entry.
Definition: BdsC.cc:8376
BError dataChannelUpdate(BInt32 append, DataChannel dataChannel, BUInt32 &id)
Add or update a DataChannel entry.
Definition: BdsC.cc:11780
BError userSetOptions(BDict< BString > &items)
Set users options.
Definition: BdsC.cc:8619
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:13977
BError userGetOptions(BDict< BString > &items)
Get users options.
Definition: BdsC.cc:8579
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:13570
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:11541
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:13754
BError responseDelete(BUInt32 id)
Delete a Response entry.
Definition: BdsC.cc:10822
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:12507
BError serverConfigurationGet(BDict< BString > &items)
Get server configuration parameters.
Definition: BdsC.cc:13827
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:8218
BError changeGetList(BUInt32 id, ListRange range, BList< Change > &changes)
Get a list of Changes.
Definition: BdsC.cc:13333
BError noteGetList(Selection sel, BList< Note > &notes)
Get a list of Notes.
Definition: BdsC.cc:13410
BError channelDelete(BUInt32 id)
Delete a Channel entry.
Definition: BdsC.cc:9659
BError dataPutBlock(DataHandle dataHandle, DataBlock data)
Send a block of data.
Definition: BdsC.cc:12912
BError userUpdate(BInt32 append, User user, BUInt32 &id)
Update or append a user entry.
Definition: BdsC.cc:8331
BError accessGroupDelete(BUInt32 id)
Delete an AccessGroup entry.
Definition: BdsC.cc:8840
BError eventGetList(Selection sel, BList< Event > &events)
Get list of Events.
Definition: BdsC.cc:10851
BError changeGetListNumber(BUInt32 id, BUInt32 &number)
Get the number of changes in a ChangeGroup.
Definition: BdsC.cc:13303
BError changeGroupStart(ChangeGroup changeGroup)
Start a new ChangeGroup when making a set of changes to the BDS's database.
Definition: BdsC.cc:13164
BError logDelete(BUInt32 id)
Delete a Log item.
Definition: BdsC.cc:13725
BError sensorUpdate(BInt32 append, Sensor sensor, BUInt32 &id)
Add or update a Sensor entry.
Definition: BdsC.cc:10340
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:9196
BError dataChannelDelete(BUInt32 id)
Delete a DataChannel entry.
Definition: BdsC.cc:11834
BError sensorDelete(BUInt32 id)
Delete a Sensor entry.
Definition: BdsC.cc:10381
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responses.
Definition: BdsC.cc:10574
BError transactionEnd(BInt32 abort)
Ends a set of transactions.
Definition: BdsC.cc:13948
BError stationDelete(BUInt32 id)
Delete a Station entry.
Definition: BdsC.cc:9328
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:12410
BError groupUpdate(BInt32 append, Group group, BUInt32 &id)
Update or append a group entry.
Definition: BdsC.cc:8699
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:12784
BError userGetList(BList< User > &users)
Get list of Users.
Definition: BdsC.cc:8276
BError specialChannelGetList(Selection sel, BList< SpecialChannel > &specialChannels)
Get list of Special Channels.
Definition: BdsC.cc:11052
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:12720
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters. If num > 0 segment ito this num...
Definition: BdsC.cc:11863
BError sqlQuery(BString query, BList< BDict< BString > > &result)
A low level SQL access function.
Definition: BdsC.cc:14126
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:13604
BError accessGroupUpdate(BInt32 append, AccessGroup group, BUInt32 &id)
Update or append an AccessGroup entry.
Definition: BdsC.cc:8804
BError setUser(BString user, BString email)
Sets user to given name or email.
Definition: BdsC.cc:8188
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:8405
BError groupDelete(BUInt32 id)
Delete a group entry.
Definition: BdsC.cc:8732
BError transactionStart()
Starts a set of transactions.
Definition: BdsC.cc:13920
BError dataFileDelete(BUInt32 id)
Delete a DataFile entry.
Definition: BdsC.cc:11658
BError sourceUpdate(BInt32 append, Source source, BUInt32 &id)
Add or update a Source entry.
Definition: BdsC.cc:9730
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Add or Update a Log item.
Definition: BdsC.cc:13688
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:9077
BError dataRealtimeGet(BUInt32 numBlocks, BUInt32 &numBlocksAvailable, BList< DataBlockChannel > &dataBlocks)
Returns the number of data blocks available and up to numBlocks of these.
Definition: BdsC.cc:13121
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:11687
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:8541
BError eventDelete(BUInt32 id)
Delete a Event entry.
Definition: BdsC.cc:11023
BError dataFileUpdate(BInt32 append, DataFileInfo dataFile, BUInt32 &id)
Add or update a DataFile entry.
Definition: BdsC.cc:11617
BError noteDelete(BUInt32 id)
Delete a Note.
Definition: BdsC.cc:13541
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:12088
BError channelUpdate(BInt32 append, Channel channel, BUInt32 &id)
Add or update a Channel entry.
Definition: BdsC.cc:9619
BError locationDelete(BUInt32 id)
Delete a Station Location entry.
Definition: BdsC.cc:9476
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:12623
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:10224
BError eventUpdate(BInt32 append, Event event, BUInt32 &id)
Add or update a Event entry.
Definition: BdsC.cc:10958
BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo)
Set the info when writing to a file.
Definition: BdsC.cc:12818
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Digitisers.
Definition: BdsC.cc:10038
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:13787
BError networkDelete(BUInt32 id)
Delete a Network entry.
Definition: BdsC.cc:9167
BError sourcePriorityUpdate(BInt32 append, SourcePriority sourcePriority, BUInt32 &id)
Definition: BdsC.cc:9836
BError specialChannelDelete(BUInt32 id)
Delete a SpecialChannel entry.
Definition: BdsC.cc:11163
BError changeGroupEnd()
End a ChangeGroup.
Definition: BdsC.cc:13198
BError specialChannelUpdate(BInt32 append, SpecialChannel specialChannel, BUInt32 &id)
Add or update a SpecialChannel entry.
Definition: BdsC.cc:11125
BError dataRealtimeConfig(BInt32 enable, Selection sel)
Configures the sending of real-time data blocks.
Definition: BdsC.cc:13064
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:11947
BError sourceDelete(BUInt32 id)
Delete a Source entry.
Definition: BdsC.cc:9765
BError changeGroupGetList(ListRange range, BList< ChangeGroup > &changeGroups)
Return a list of ChangeGroups.
Definition: BdsC.cc:13226
BError userSet(User user)
Set user info of the currently loogged in user.
Definition: BdsC.cc:8498
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:14036
BError databaseRestore(BString ref, BString type)
Restore the database.
Definition: BdsC.cc:14096
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:13493
BError metadataGetChannelInfo(Selection sel, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:11192
BError networkUpdate(BInt32 append, Network network, BUInt32 &id)
Add or update a Network entry.
Definition: BdsC.cc:9127
BError connect(BString user, BString password)
Provides user/password information.
Definition: BdsC.cc:8128
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:10114
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:14007
BError channelGet(BUInt32 id, Channel &channel)
Get a specific channel given its ID.
Definition: BdsC.cc:9580
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:10300
BError responseUpdate(BInt32 append, Response response, BUInt32 &id)
Add or update a Response entry.
Definition: BdsC.cc:10723
BError channelInstrumentDelete(BUInt32 id)
Delete an Instrument entry.
Definition: BdsC.cc:10009
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:9688
BError digitiserUpdate(BInt32 append, Digitiser digitiser, BUInt32 &id)
Add or update a Digitiser entry.
Definition: BdsC.cc:10154
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
Read the length of the raw formated data file.
Definition: BdsC.cc:13033
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:8246
BError channelInstrumentUpdate(BInt32 append, ChannelInstrument channelInstrument, BUInt32 &id)
Add or update a Instrument entry.
Definition: BdsC.cc:9972
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:8869
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the file.
Definition: BdsC.cc:12996
BError userGet(User &user)
Get user info of the currently loogged in user.
Definition: BdsC.cc:8452
This class defines a calibration setting.
Definition: BdsD.h:352
This holds information on a set of Changes.
Definition: BdsD.h:814
This class provides Metadata information on a set of channels.
Definition: BdsD.h:564
This class defines a Channel's instrument.
Definition: BdsD.h:435
This class defines a seismic data Channel.
Definition: BdsD.h:458
This defines the set of clean options used in the clean() function.
Definition: BdsD.h:897
This is the Data Access API interface to the BDS system.
Definition: BdsC.h:26
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:2061
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:824
BError serverConfigurationGet(BDict< BString > &items)
Get server configuration parameters.
Definition: BdsC.cc:3854
BError metadataGetChannelInfo(Selection sel, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:1712
BError dataRealtimeGet(BUInt32 numBlocks, BUInt32 &numBlocksAvailable, BList< DataBlockChannel > &dataBlocks)
Returns the number of data blocks available and up to numBlocks of these.
Definition: BdsC.cc:3381
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responces.
Definition: BdsC.cc:1306
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:504
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:2353
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:2494
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the file.
Definition: BdsC.cc:3256
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:664
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of data formats.
Definition: BdsC.cc:3894
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Digitisers.
Definition: BdsC.cc:989
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:414
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:3555
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:3126
BError noteGetList(Selection sel, BList< Note > &notes)
Return a list of Notes.
Definition: BdsC.cc:3424
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:3086
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:3785
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:2913
BError eventGetList(Selection sel, BList< Event > &events)
Get list of Events.
Definition: BdsC.cc:1532
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:1105
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:42
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:748
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Instruments.
Definition: BdsC.cc:917
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Add or update a Log item.
Definition: BdsC.cc:3625
BError userGet(User &user)
Get user info of the currently loogged in user.
Definition: BdsC.cc:207
BError userSetOptions(BDict< BString > &items)
Set users options.
Definition: BdsC.cc:374
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:2816
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:3224
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters. If num > 0 segment ito this num...
Definition: BdsC.cc:2269
BError dataRealtimeConfig(BInt32 enable, Selection sel)
Configures the sending of real-time data blocks.
Definition: BdsC.cc:3324
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:3814
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:589
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:2181
BError specialChannelGetList(Selection sel, BList< SpecialChannel > &specialChannels)
Get list of Special Channels.
Definition: BdsC.cc:1639
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:3662
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:3754
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station, Channel or both Locations depending on the sel.locationSelect parameter.
Definition: BdsC.cc:1455
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:1221
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
Read the length of the raw formated data file.
Definition: BdsC.cc:3293
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:1065
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:102
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:3725
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:454
BError metadataGetFormatted(Selection sel, BString format, BArray< BUInt8 > &data)
Return the channel MetaData in a particular format.
Definition: BdsC.cc:1998
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:3695
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:3507
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:3160
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:1181
BError userSet(User user)
Set user info of the currently loogged in user.
Definition: BdsC.cc:253
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:296
BError connect(BString user, BString password)
Provides user/password information for secure connection.
Definition: BdsC.cc:12
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:3589
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:706
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:130
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:160
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:3029
BError userGetOptions(BDict< BString > &items)
Get users options.
Definition: BdsC.cc:334
This is the DataAdd Access API interface.
Definition: BdsC.h:103
BError dataSearch(Selection selection, DataInfo &dataInfo)
Search for data matching the given selection parameters.
Definition: BdsC.cc:6385
BError eventGetList(Selection sel, BList< Event > &events)
Get list of Events.
Definition: BdsC.cc:5470
BError eventUpdate(BInt32 append, Event event, BUInt32 &id)
Add or update a Event entry.
Definition: BdsC.cc:5577
BError specialChannelGetList(Selection sel, BList< SpecialChannel > &specialChannels)
Get list of Special Channels.
Definition: BdsC.cc:5671
BError sensorGet(BUInt32 id, Sensor &sensor)
Get a Sensor object given its ID.
Definition: BdsC.cc:5119
BError userGetFromId(BUInt32 id, User &user)
Get user info given user ID.
Definition: BdsC.cc:4098
BError channelGetList(Selection sel, BList< Channel > &channels)
Get list of Channels.
Definition: BdsC.cc:4527
BError getVersion(BString &version, BString &name)
Gets the software version and server name.
Definition: BdsC.cc:4068
BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:6526
BError serverConfigurationGet(BDict< BString > &items)
Get server configuration parameters.
Definition: BdsC.cc:8032
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data)
Return a block of data.
Definition: BdsC.cc:7192
BError userSet(User user)
Set user info of the currently loogged in user.
Definition: BdsC.cc:4191
BError connect(BString user, BString password)
Provides user/password information.
Definition: BdsC.cc:3950
BError modeSnapshotPause(BInt32 on)
Enables/disables backup synchronisation pause.
Definition: BdsC.cc:7903
BError noteReadDocument(BUInt32 id, BString &format, BArray< BUInt8 > &data)
Read a document associated with a Note.
Definition: BdsC.cc:7767
BError metadataGetChannelInfo(Selection sel, ChannelInfos &channelInfos)
Return the channel MetaData in structured form.
Definition: BdsC.cc:5744
BError statisticsGet(BDict< BString > &info)
Get a list of system statistics.
Definition: BdsC.cc:7992
BError noteWriteDocument(BUInt32 id, BString format, BArray< BUInt8 > data)
Given a Note write a document associated with it.
Definition: BdsC.cc:7733
BError dataClose(DataHandle dataHandle, BError error, BInt32 del)
Close a file.
Definition: BdsC.cc:7402
BError networkGetList(BList< Network > &networks)
Get list of Networks.
Definition: BdsC.cc:4392
BError setUser(BString user, BString email)
Sets user to given name or email.
Definition: BdsC.cc:4010
BError databaseBackup(BString &ref)
Backup the database.
Definition: BdsC.cc:7963
BError stationGetList(Selection sel, BList< Station > &stations)
Get list of Stations.
Definition: BdsC.cc:4442
BError calibrationGetList(Selection sel, BList< Calibration > &calibrations)
Get list of Calibrations.
Definition: BdsC.cc:5159
BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle)
Open a data file.
Definition: BdsC.cc:6848
BError userGetOptions(BDict< BString > &items)
Get users options.
Definition: BdsC.cc:4272
BError userGet(User &user)
Get user info of the currently loogged in user.
Definition: BdsC.cc:4145
BError sourceGetList(BList< Source > &sources)
Get list of Sources.
Definition: BdsC.cc:4602
BError dataFileGetList(Selection sel, BList< DataFileInfo > &dataFile)
Get list of DataFiles.
Definition: BdsC.cc:4686
BError responseGetList(Selection sel, BList< Response > &responses)
Get list of Responses.
Definition: BdsC.cc:5244
BError sensorGetList(Selection sel, BList< Sensor > &sensors)
Get list of Sensors.
Definition: BdsC.cc:5043
BError eventDelete(BUInt32 id)
Delete a Event entry.
Definition: BdsC.cc:5642
BError noteGetList(Selection sel, BList< Note > &notes)
Return a list of Notes.
Definition: BdsC.cc:7602
BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo)
Get information on the data file.
Definition: BdsC.cc:6945
BError getSelections(SelectionGroup group, Selection selectionIn, Selection &selectionOut)
Get selection list.
Definition: BdsC.cc:6213
BError dataFormattedGetLength(DataHandle dataHandle, BUInt64 &length)
The total length in bytes of the formated data.
Definition: BdsC.cc:7471
BError dataAvailability(Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans)
Return availability for data matching the given selection parameters. If num > 0 segment ito this num...
Definition: BdsC.cc:6301
BError dataChannelGetList(Selection sel, BList< DataChannel > &dataChannel)
Get list of DataChannels.
Definition: BdsC.cc:4762
BError validateUser(BString user, BString email)
Checks the user given name or email.
Definition: BdsC.cc:3980
BError dataGetNotes(DataHandle dataHandle, BList< Note > &notes)
Get notes on the data file.
Definition: BdsC.cc:7061
BError groupGetList(BList< Group > &groups)
Get list of Groups.
Definition: BdsC.cc:4352
BError digitiserGetList(Selection sel, BList< Digitiser > &digitisers)
Get list of Channels.
Definition: BdsC.cc:4927
BError digitiserGet(BUInt32 id, Digitiser &digitiser)
Get a Digitiser object given its ID.
Definition: BdsC.cc:5003
BError modeSet(Mode mode, Mode &previousMode)
Changes the system mode from Master to slave.
Definition: BdsC.cc:7873
BError sourcePriorityGetList(BList< SourcePriority > &sourcePrioritys)
Get list of SourcePriorities.
Definition: BdsC.cc:4644
BError dataRealtimeConfig(BInt32 enable, Selection sel)
Configures the sending of real-time data blocks.
Definition: BdsC.cc:7502
BError dataGetWarnings(DataHandle dataHandle, BList< BString > &warnings)
Get information on the data file.
Definition: BdsC.cc:7118
BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber)
Searches for a data block matching the time given.
Definition: BdsC.cc:7158
BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo)
Get information on possible selections. Use in GUI programs to list options available.
Definition: BdsC.cc:6093
BError channelInstrumentGetList(Selection sel, BList< ChannelInstrument > &channelInstruments)
Get list of Instruments.
Definition: BdsC.cc:4855
BError metadataGetFormatted(Selection sel, BString format, BArray< BUInt8 > &data)
Return the channel MetaData in a particular format.
Definition: BdsC.cc:6030
BError dataRealtimeGet(BUInt32 numBlocks, BUInt32 &numBlocksAvailable, BList< DataBlockChannel > &dataBlocks)
Returns the number of data blocks available and up to numBlocks of these.
Definition: BdsC.cc:7559
BError noteUpdate(BInt32 append, Note note, BUInt32 &id)
Add or update a Note.
Definition: BdsC.cc:7685
BError setUserReal()
Sets user back to real user.
Definition: BdsC.cc:4040
BError userGetGroups(BList< BString > &groups)
Get list of groups the user belongs to.
Definition: BdsC.cc:4234
BError dataFormatGetList(BList< DataFormat > &formats)
Get list of data formats.
Definition: BdsC.cc:8072
BError userSetOptions(BDict< BString > &items)
Set users options.
Definition: BdsC.cc:4312
BError dataPutBlock(DataHandle dataHandle, DataBlock data)
Send a block of data.
Definition: BdsC.cc:7350
BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description)
Append a log item.
Definition: BdsC.cc:7840
BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo)
Set the info when writing to a file.
Definition: BdsC.cc:7256
BError logUpdate(BInt32 append, Log log, BUInt32 &id)
Append a log item ///< Add or update a Log item.
Definition: BdsC.cc:7803
BError locationGetList(Selection sel, BList< Location > &locations)
Get list of Station, Channel or both Locations depending on the sel.locationSelect parameter.
Definition: BdsC.cc:5393
BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data)
Read the raw data from the stream.
Definition: BdsC.cc:7434
BError clean(CleanOptions cleanOptions)
Cleans the system logs and Changes information.
Definition: BdsC.cc:7932
This class provides the actual Sensor data values contained within a single data block.
Definition: BdsD.h:707
This class defines information on a single channel's set of data stored in a file.
Definition: BdsD.h:605
This class defines information on a Sensor data file.
Definition: BdsD.h:576
This defines a handle to a sensor data stream/file when opened for read or write.
Definition: BdsD.h:687
This class defines information on a set of data.
Definition: BdsD.h:640
This class defines a seismic Digitiser.
Definition: BdsD.h:385
This class defines a seismic event.
Definition: BdsD.h:949
This holds information on a User security group.
Definition: BdsD.h:755
This class defines an integer based range.
Definition: BdsD.h:82
This class defines the physical location of a Station.
Definition: BdsD.h:205
This defines the selection cirteria when requesting a set of log entries.
Definition: BdsD.h:886
This holds information on a Log entry.
Definition: BdsD.h:867
This class defines a seismic Network organisation.
Definition: BdsD.h:98
This holds information on a Note for general information.
Definition: BdsD.h:835
This class defines a seismic Response characteristic.
Definition: BdsD.h:311
This class defines the set of Metadata or Siesmic sensor data to be selected when getSelectionInfo() ...
Definition: BdsD.h:481
This class defines a generic Metadata or Sensor data selection.
Definition: BdsD.h:515
This class defines a seismic Sensor.
Definition: BdsD.h:409
This class defines a Source Priority entry.
Definition: BdsD.h:138
This class defines a seismic data Source.
Definition: BdsD.h:118
A Special channel identifier.
Definition: BdsD.h:927
This class defines a seismic station.
Definition: BdsD.h:187
This holds information on a user.
Definition: BdsD.h:732
Definition: BdsC.cc:8
const BUInt32 apiVersion
Definition: BdsC.h:19
Mode
BdsServer mode.
Definition: BdsD.h:35
SelectionGroup
The Selection group when making selections.
Definition: BdsD.h:41