BdsC.h

Go to the documentation of this file.

/*******************************************************************************
 *  BdsC.h  Produced by Bidl
 *******************************************************************************
 */
 
#ifndef BDSC_H
#define BDSC_H 1
 
#include <stdlib.h>
#include <stdint.h>
#include <Boap.h>
#include <BString.h>
#include <BList.h>
#include <BArray.h>
#include <BdsD.h>
 
 
namespace Bds {
    const BUInt32 apiVersion = 0;
 
    
    class DataAccess : public BoapClientObject {
    public:
            DataAccess(BString name = "");
        BError connect(BString user, BString password); 
        BError validateUser(BString user, BString email);   
        BError setUser(BString user, BString email);    
        BError setUserReal();   
        BError getVersion(BString& version, BString& name); 
        // User functions
        BError userGetFromId(BUInt32 id, User& user);   
        BError userGet(User& user); 
        BError userSet(User user);  
        BError userGetGroups(BList<BString >& groups);  
        BError userGetOptions(BDict<BString >& items);  
        BError userSetOptions(BDict<BString >& items);  
        BError groupGetList(BList<Group >& groups); 
        // Information functions
        BError networkGetList(BList<Network >& networks);   
        BError stationGetList(Selection sel, BList<Station >& stations);    
        BError channelGetList(Selection sel, BList<Channel >& channels);    
        BError sourceGetList(BList<Source >& sources);  
        BError sourcePriorityGetList(BList<SourcePriority >& sourcePrioritys);  
        BError dataFileGetList(Selection sel, BList<DataFileInfo >& dataFile);  
        BError dataChannelGetList(Selection sel, BList<DataChannel >& dataChannel); 
        BError channelInstrumentGetList(Selection sel, BList<ChannelInstrument >& channelInstruments);  
        BError digitiserGetList(Selection sel, BList<Digitiser >& digitisers);  
        BError digitiserGet(BUInt32 id, Digitiser& digitiser);  
        BError sensorGetList(Selection sel, BList<Sensor >& sensors);   
        BError sensorGet(BUInt32 id, Sensor& sensor);   
        BError calibrationGetList(Selection sel, BList<Calibration >& calibrations);    
        BError responseGetList(Selection sel, BList<Response >& responses); 
        BError locationGetList(Selection sel, BList<Location >& locations); 
        BError eventGetList(Selection sel, BList<Event >& events);  
        BError specialChannelGetList(Selection sel, BList<SpecialChannel >& specialChannels);   
        BError metadataGetChannelInfo(Selection sel, MetadataOption options, ChannelInfos& channelInfos);   
        BError metadataGetFormatted(Selection sel, MetadataOption options, BString format, BArray<BUInt8 >& data);  
        // Selections
        BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo); 
        BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut); 
        // Data access functions
        BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);  
        BError dataSearch(Selection selection, DataInfo& dataInfo); 
        BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);   
        BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);    
        BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);   
        BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);    
        BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);   
        BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);   
        BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data); 
        BError dataClose(DataHandle dataHandle, BError error, BInt32 del);  
        BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray<BUInt8 >& data); 
        BError dataFormattedGetLength(DataHandle dataHandle, BUInt64& length);  
        // Real-time data functions
        BError dataRealtimeConfig(BInt32 enable, Selection sel);    
        BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);   
        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 noticesAdd(BString notice);  
        BError noticesGetList(BList<BString >& notices);    
        BError noticesClear();  
        BError logUpdate(BInt32 append, Log log, BUInt32& id);  
        BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);    
        // Management functions
        BError modeSet(Mode mode, Mode& previousMode);  
        BError modeSnapshotPause(BInt32 on);    
        BError clean(CleanOptions cleanOptions);    
        BError databaseBackup(BString& ref);    
        // Information functions
        BError statisticsGet(BDict<BString >& info);    
        BError serverConfigurationGet(BDict<BString >& items);  
        BError dataFormatGetList(BList<DataFormat >& formats);  
    private:
    };
    class DataAddAccess : public BoapClientObject {
    public:
            DataAddAccess(BString name = "");
        BError connect(BString user, BString password); 
        BError validateUser(BString user, BString email);   
        BError setUser(BString user, BString email);    
        BError setUserReal();   
        BError getVersion(BString& version, BString& name); 
        // User functions
        BError userGetFromId(BUInt32 id, User& user);   
        BError userGet(User& user); 
        BError userSet(User user);  
        BError userGetGroups(BList<BString >& groups);  
        BError userGetOptions(BDict<BString >& items);  
        BError userSetOptions(BDict<BString >& items);  
        BError groupGetList(BList<Group >& groups); 
        // Information functions
        BError networkGetList(BList<Network >& networks);   
        BError stationGetList(Selection sel, BList<Station >& stations);    
        BError channelGetList(Selection sel, BList<Channel >& channels);    
        BError sourceGetList(BList<Source >& sources);  
        BError sourcePriorityGetList(BList<SourcePriority >& sourcePrioritys);  
        BError dataFileGetList(Selection sel, BList<DataFileInfo >& dataFile);  
        BError dataChannelGetList(Selection sel, BList<DataChannel >& dataChannel); 
        BError channelInstrumentGetList(Selection sel, BList<ChannelInstrument >& channelInstruments);  
        BError digitiserGetList(Selection sel, BList<Digitiser >& digitisers);  
        BError digitiserGet(BUInt32 id, Digitiser& digitiser);  
        BError sensorGetList(Selection sel, BList<Sensor >& sensors);   
        BError sensorGet(BUInt32 id, Sensor& sensor);   
        BError calibrationGetList(Selection sel, BList<Calibration >& calibrations);    
        BError responseGetList(Selection sel, BList<Response >& responses); 
        BError locationGetList(Selection sel, BList<Location >& locations); 
        BError eventGetList(Selection sel, BList<Event >& events);  
        BError eventUpdate(BInt32 append, Event event, BUInt32& id);    
        BError eventDelete(BUInt32 id); 
        BError specialChannelGetList(Selection sel, BList<SpecialChannel >& specialChannels);   
        BError metadataGetChannelInfo(Selection sel, MetadataOption options, ChannelInfos& channelInfos);   
        BError metadataGetFormatted(Selection sel, MetadataOption options, BString format, BArray<BUInt8 >& data);  
        // Selections
        BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo); 
        BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut); 
        // Data access functions
        BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);  
        BError dataSearch(Selection selection, DataInfo& dataInfo); 
        BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);   
        BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);    
        BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);   
        BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);    
        BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);   
        BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);   
        BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data); 
        BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);   
        BError dataPutBlock(DataHandle dataHandle, DataBlock data); 
        BError dataClose(DataHandle dataHandle, BError error, BInt32 del);  
        BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray<BUInt8 >& data); 
        BError dataFormattedGetLength(DataHandle dataHandle, BUInt64& length);  
        // Real-time data functions
        BError dataRealtimeConfig(BInt32 enable, Selection sel);    
        BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);   
        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 noticesAdd(BString notice);  
        BError noticesGetList(BList<BString >& notices);    
        BError noticesClear();  
        BError logUpdate(BInt32 append, Log log, BUInt32& id);  
        BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);    
        // Management functions
        BError modeSet(Mode mode, Mode& previousMode);  
        BError modeSnapshotPause(BInt32 on);    
        BError clean(CleanOptions cleanOptions);    
        BError databaseBackup(BString& ref);    
        // Information functions
        BError statisticsGet(BDict<BString >& info);    
        BError serverConfigurationGet(BDict<BString >& items);  
        BError dataFormatGetList(BList<DataFormat >& formats);  
    private:
    };
    class AdminAccess : public BoapClientObject {
    public:
            AdminAccess(BString name = "");
        BError connect(BString user, BString password); 
        BError validateUser(BString user, BString email);   
        BError setUser(BString user, BString email);    
        BError setUserReal();   
        BError getVersion(BString& version, BString& name); 
        // User functions
        BError userGetList(BList<User >& users);    
        BError userUpdate(BInt32 append, User user, BUInt32& id);   
        BError userDelete(BUInt32 id);  
        BError userGetFromId(BUInt32 id, User& user);   
        BError userGet(User& user); 
        BError userSet(User user);  
        BError userGetGroups(BList<BString >& groups);  
        BError userGetOptions(BDict<BString >& items);  
        BError userSetOptions(BDict<BString >& items);  
        BError groupGetList(BList<Group >& groups); 
        BError groupUpdate(BInt32 append, Group group, BUInt32& id);    
        BError groupDelete(BUInt32 id); 
        BError accessGroupGetList(BList<AccessGroup >& accessGroups);   
        BError accessGroupUpdate(BInt32 append, AccessGroup group, BUInt32& id);    
        BError accessGroupDelete(BUInt32 id);   
        // Selections
        BError getSelectionInfo(SelectionGroup group, Selection selectionIn, SelectionInfo& selectionInfo); 
        BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut); 
        BError networkGetList(BList<Network >& networks);   
        BError networkUpdate(BInt32 append, Network network, BUInt32& id);  
        BError networkDelete(BUInt32 id);   
        BError stationGetList(Selection sel, BList<Station >& stations);    
        BError stationUpdate(BInt32 append, Station station, BUInt32& id);  
        BError stationDelete(BUInt32 id);   
        BError locationGetList(Selection sel, BList<Location >& locations); 
        BError locationUpdate(BInt32 append, Location location, BUInt32& id);   
        BError locationDelete(BUInt32 id);  
        BError channelGetList(Selection sel, BList<Channel >& channels);    
        BError channelGet(BUInt32 id, Channel& channel);    
        BError channelUpdate(BInt32 append, Channel channel, BUInt32& id);  
        BError channelDelete(BUInt32 id);   
        BError sourceGetList(BList<Source >& sources);  
        BError sourceUpdate(BInt32 append, Source source, BUInt32& id); 
        BError sourceDelete(BUInt32 id);    
        BError sourcePriorityGetList(BList<SourcePriority >& sourcePrioritys);  
        BError sourcePriorityUpdate(BInt32 append, SourcePriority sourcePriority, BUInt32& id);
        BError sourcePriorityDelete(BUInt32 id);
        BError channelInstrumentGetList(Selection sel, BList<ChannelInstrument >& channelInstruments);  
        BError channelInstrumentUpdate(BInt32 append, ChannelInstrument channelInstrument, BUInt32& id);    
        BError channelInstrumentDelete(BUInt32 id); 
        BError digitiserGetList(Selection sel, BList<Digitiser >& digitisers);  
        BError digitiserGet(BUInt32 id, Digitiser& digitiser);  
        BError digitiserUpdate(BInt32 append, Digitiser digitiser, BUInt32& id);    
        BError digitiserDelete(BUInt32 id); 
        BError sensorGetList(Selection sel, BList<Sensor >& sensors);   
        BError sensorGet(BUInt32 id, Sensor& sensor);   
        BError sensorUpdate(BInt32 append, Sensor sensor, BUInt32& id); 
        BError sensorDelete(BUInt32 id);    
        BError calibrationGetList(Selection sel, BList<Calibration >& calibrations);    
        BError calibrationUpdate(BInt32 append, Calibration calibration, BUInt32& id);  
        BError calibrationDelete(BUInt32 id);   
        BError responseGetList(Selection sel, BList<Response >& responses); 
        BError responseUpdate(BInt32 append, Response response, BUInt32& id);   
        BError responseDelete(BUInt32 id);  
        BError eventGetList(Selection sel, BList<Event >& events);  
        BError eventUpdate(BInt32 append, Event event, BUInt32& id);    
        BError eventDelete(BUInt32 id); 
        BError specialChannelGetList(Selection sel, BList<SpecialChannel >& specialChannels);   
        BError specialChannelUpdate(BInt32 append, SpecialChannel specialChannel, BUInt32& id); 
        BError specialChannelDelete(BUInt32 id);    
        BError metadataGetChannelInfo(Selection sel, MetadataOption options, ChannelInfos& channelInfos);   
        BError metadataGetFormatted(Selection sel, MetadataOption options, BString format, BArray<BUInt8 >& data);  
        // Data access functions
        BError dataFileGetList(Selection sel, BList<DataFileInfo >& dataFile);  
        BError dataFileUpdate(BInt32 append, DataFileInfo dataFile, BUInt32& id);   
        BError dataFileDelete(BUInt32 id);  
        BError dataChannelGetList(Selection sel, BList<DataChannel >& dataChannel); 
        BError dataChannelUpdate(BInt32 append, DataChannel dataChannel, BUInt32& id);  
        BError dataChannelDelete(BUInt32 id);   
        BError dataAvailability(Selection selection, BUInt32 num, BArray<DataAvailChan >& dataAvailChans);  
        BError dataSearch(Selection selection, DataInfo& dataInfo); 
        BError dataGetChannelInfo(DataInfo dataInfo, ChannelInfos& channelInfos);   
        BError dataOpen(DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle& dataHandle);    
        BError dataGetInfo(DataHandle dataHandle, BUInt32 infoExtra, DataInfo& dataInfo);   
        BError dataGetNotes(DataHandle dataHandle, BList<Note >& notes);    
        BError dataGetWarnings(DataHandle dataHandle, BList<BString >& warnings);   
        BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock& data); 
        BError dataSeekBlock(DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32& blockNumber);   
        BError dataSetInfo(DataHandle dataHandle, DataInfo dataInfo);   
        BError dataPutBlock(DataHandle dataHandle, DataBlock data); 
        BError dataClose(DataHandle dataHandle, BError error, BInt32 del);  
        BError dataFormattedRead(DataHandle dataHandle, BUInt32 number, BArray<BUInt8 >& data); 
        BError dataFormattedGetLength(DataHandle dataHandle, BUInt64& length);  
        // Real-time data functions
        BError dataRealtimeConfig(BInt32 enable, Selection sel);    
        BError dataRealtimeGet(BUInt32 numBlocks, BUInt32& numBlocksAvailable, BList<DataBlockChannel >& dataBlocks);   
        // Change/Logging functions
        BError changeGroupStart(ChangeGroup changeGroup);   
        BError changeGroupEnd();    
        BError changeGroupGetList(ListRange range, BList<ChangeGroup >& changeGroups);  
        BError changeGroupDelete(BTimeStamp beforeDate, BString type, BInt32 empty);    
        BError changeGetListNumber(BUInt32 id, BUInt32& number);    
        BError changeGetList(BUInt32 id, ListRange range, BList<Change >& changes); 
        BError changeDelete(BTimeStamp beforeDate, BString type);   
        BError noteGetList(Selection sel, BList<Note >& notes); 
        BError noteUpdate(BInt32 append, Note note, BUInt32& id);   
        BError noteDelete(BUInt32 id);  
        BError noteWriteDocument(BUInt32 id, BString format, BArray<BUInt8 > data); 
        BError noteReadDocument(BUInt32 id, BString& format, BArray<BUInt8 >& data);    
        BError noticesAdd(BString notice);  
        BError noticesGetList(BList<BString >& notices);    
        BError noticesClear();  
        BError logGetList(LogSelect sel, BList<Log >& logs);    
        BError logUpdate(BInt32 append, Log log, BUInt32& id);  
        BError logDelete(BUInt32 id);   
        BError logAppend(BString type, BUInt32 priority, BString subSystem, BString title, BString description);    
        // Information functions
        BError statisticsGet(BDict<BString >& info);    
        BError serverConfigurationGet(BDict<BString >& items);  
        BError dataFormatGetList(BList<DataFormat >& formats);  
        // Management functions
        BError transactionStart();  
        BError transactionEnd(BInt32 abort);    
        BError modeSet(Mode mode, Mode& previousMode);  
        BError modeSnapshotPause(BInt32 on);    
        BError clean(CleanOptions cleanOptions);    
        BError databaseBackup(BString& ref);    
        BError databaseRestore(BString ref, BString type);  
        // Low level functions
        BError sqlQuery(BString query, BList<BDict<BString > >& result);    
        BError extraCall(BUInt32 function, BString args, BString& result);  
    private:
    };
}
#endif