BdsApi
1.2.10
|
This is the AdminAccess API interface. More...
#include <BdsC.h>
Public Member Functions | |
AdminAccess (BString name="") | |
BError | connect (BString user, BString password) |
Provides user/password information. | |
BError | validateUser (BString user, BString email) |
Checks the user given name or email. | |
BError | setUser (BString user, BString email) |
Sets user to given name or email. | |
BError | setUserReal () |
Sets user back to real user. | |
BError | getVersion (BString &version, BString &name) |
Gets the software version and server name. | |
BError | userGetList (BList< User > &users) |
Get list of Users. | |
BError | userUpdate (BInt32 append, User user, BUInt32 &id) |
Update or append a user entry. | |
BError | userDelete (BUInt32 id) |
Delete a user entry. | |
BError | userGet (User &user) |
BError | userSet (User user) |
Get user info. | |
BError | userGetGroups (BList< BString > &groups) |
Set user info. | |
BError | groupGetList (BList< Group > &groups) |
Get list of groups the user belongs to. | |
BError | groupUpdate (BInt32 append, Group group, BUInt32 &id) |
Update or append a group entry. | |
BError | groupDelete (BUInt32 id) |
Delete a group entry. | |
BError | accessGroupGetList (BList< AccessGroup > &accessGroups) |
Get list of AccessGroups. | |
BError | accessGroupUpdate (BInt32 append, AccessGroup group, BUInt32 &id) |
Update or append an AccessGroup entry. | |
BError | accessGroupDelete (BUInt32 id) |
Delete an AccessGroup entry. | |
BError | getSelectionInfo (SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo) |
Get selection info. | |
BError | getSelections (SelectionGroup group, Selection selectionIn, Selection &selectionOut) |
Get selection list. | |
BError | networkGetList (BList< Network > &networks) |
Get list of Networks. | |
BError | networkUpdate (BInt32 append, Network network, BUInt32 &id) |
BError | networkDelete (BUInt32 id) |
BError | stationGetList (Selection sel, BList< Station > &stations) |
Get list of Stations. | |
BError | stationUpdate (BInt32 append, Station station, BUInt32 &id) |
BError | stationDelete (BUInt32 id) |
BError | locationGetList (Selection sel, BList< Location > &locations) |
Get list of Station Locations. | |
BError | locationUpdate (BInt32 append, Location location, BUInt32 &id) |
BError | locationDelete (BUInt32 id) |
BError | channelGetList (Selection sel, BList< Channel > &channels) |
Get list of Channels. | |
BError | channelGet (BUInt32 id, Channel &channel) |
Get a channel. | |
BError | channelUpdate (BInt32 append, Channel channel, BUInt32 &id) |
BError | channelDelete (BUInt32 id) |
BError | sourceGetList (BList< Source > &sources) |
Get list of Sources. | |
BError | sourceUpdate (BInt32 append, Source source, BUInt32 &id) |
BError | sourceDelete (BUInt32 id) |
BError | sourcePriorityGetList (BList< SourcePriority > &sourcePrioritys) |
Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities. | |
BError | sourcePriorityUpdate (BInt32 append, SourcePriority sourcePriority, BUInt32 &id) |
BError | sourcePriorityDelete (BUInt32 id) |
BError | channelInstrumentGetList (Selection sel, BList< ChannelInstrument > &channelInstruments) |
Get list of Channel Instruments. | |
BError | channelInstrumentUpdate (BInt32 append, ChannelInstrument channelInstrument, BUInt32 &id) |
BError | channelInstrumentDelete (BUInt32 id) |
BError | digitiserGetList (Selection sel, BList< Digitiser > &digitisers) |
Get list of Channels. | |
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) |
Get list of Channels. | |
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) |
Get list of Channels. | |
BError | calibrationUpdate (BInt32 append, Calibration calibration, BUInt32 &id) |
BError | calibrationDelete (BUInt32 id) |
BError | responseGetList (Selection sel, BList< Response > &responses) |
Get list of Channels. | |
BError | responseUpdate (BInt32 append, Response response, BUInt32 &id) |
BError | responseDelete (BUInt32 id) |
BError | dataFileGetList (Selection sel, BList< DataFileInfo > &dataFile) |
Get list of DataFiles. | |
BError | dataFileUpdate (BInt32 append, DataFileInfo dataFile, BUInt32 &id) |
BError | dataFileDelete (BUInt32 id) |
BError | dataChannelGetList (Selection sel, BList< DataChannel > &dataChannel) |
Get list of DataChannels. | |
BError | dataChannelUpdate (BInt32 append, DataChannel dataChannel, BUInt32 &id) |
BError | dataChannelDelete (BUInt32 id) |
BError | dataSearch (Selection selection, DataInfo &dataInfo) |
Search for data matching the given selection parameters. | |
BError | dataGetChannelInfo (DataInfo dataInfo, ChannelInfos &channelInfos) |
Return the channel MetaData in structured form. | |
BError | dataOpen (DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle) |
Open a data stream. | |
BError | dataGetInfo (DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo) |
Get information on the data stream. | |
BError | dataGetNotes (DataHandle dataHandle, BList< Note > ¬es) |
Get notes on the data stream. | |
BError | dataGetWarnings (DataHandle dataHandle, BList< BString > &warnings) |
Get information on the data stream. | |
BError | dataGetBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data) |
Return a block of data. | |
BError | dataSeekBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber) |
Searches for a data block matching the time given. | |
BError | dataSetInfo (DataHandle dataHandle, DataInfo dataInfo) |
Set the info when writing to a stream. | |
BError | dataPutBlock (DataHandle dataHandle, DataBlock data) |
Send a block of data. | |
BError | dataClose (DataHandle dataHandle, BError error, BInt32 del) |
Close a stream. | |
BError | dataFormattedRead (DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data) |
Read the raw data from the stream. | |
BError | dataFormattedGetLength (DataHandle dataHandle, BUInt64 &length) |
Read the raw data from the stream. | |
BError | 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 > ¬es) |
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 | logGetList (LogSelect sel, BList< Log > &logs) |
Get list of log entries. | |
BError | logUpdate (BInt32 append, Log log, BUInt32 &id) |
Append a log item. | |
BError | logDelete (BUInt32 id) |
BError | logAppend (BString type, BUInt32 priority, BString subSystem, BString title, BString description) |
Append a log item. | |
BError | statisticsGet (BDict< BString > &info) |
BError | dataFormatGetList (BList< DataFormat > &formats) |
Get list of data formats. | |
BError | transactionStart () |
Starts a set of transactions. | |
BError | transactionEnd (BInt32 abort) |
Ends a set of transactions. | |
BError | modeSet (Mode mode, Mode &previousMode) |
Changes the system mode from Master to slave. | |
BError | modeSnapshotPause (BInt32 on) |
Enables/disables backup synchronisation pause. | |
BError | clean (CleanOptions cleanOptions) |
Cleans the system logs and Changes information. | |
BError | databaseBackup (BString &ref) |
Backup the database. | |
BError | databaseRestore (BString ref) |
Restore the database. | |
BError | sqlQuery (BString query, BList< BDict< BString > > &result) |
A low level SQL access function. |
This is the AdminAccess API interface.
Bds::AdminAccess::AdminAccess | ( | BString | name = "" | ) |
BError Bds::AdminAccess::accessGroupDelete | ( | BUInt32 | id | ) |
Delete an AccessGroup entry.
BError Bds::AdminAccess::accessGroupGetList | ( | BList< AccessGroup > & | accessGroups | ) |
Get list of AccessGroups.
BError Bds::AdminAccess::accessGroupUpdate | ( | BInt32 | append, |
AccessGroup | group, | ||
BUInt32 & | id | ||
) |
Update or append an AccessGroup entry.
BError Bds::AdminAccess::calibrationDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::calibrationGetList | ( | Selection | sel, |
BList< Calibration > & | calibrations | ||
) |
Get list of Channels.
BError Bds::AdminAccess::calibrationUpdate | ( | BInt32 | append, |
Calibration | calibration, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::changeDelete | ( | BTimeStamp | beforeDate, |
BString | type | ||
) |
BError Bds::AdminAccess::changeGetListNumber | ( | BUInt32 | id, |
BUInt32 & | number | ||
) |
BError Bds::AdminAccess::changeGroupDelete | ( | BTimeStamp | beforeDate, |
BString | type, | ||
BInt32 | empty | ||
) |
BError Bds::AdminAccess::changeGroupEnd | ( | ) |
BError Bds::AdminAccess::changeGroupGetList | ( | ListRange | range, |
BList< ChangeGroup > & | changeGroups | ||
) |
BError Bds::AdminAccess::changeGroupStart | ( | ChangeGroup | changeGroup | ) |
BError Bds::AdminAccess::channelDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::channelGet | ( | BUInt32 | id, |
Channel & | channel | ||
) |
Get a channel.
Get list of Channels.
BError Bds::AdminAccess::channelInstrumentDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::channelInstrumentGetList | ( | Selection | sel, |
BList< ChannelInstrument > & | channelInstruments | ||
) |
Get list of Channel Instruments.
BError Bds::AdminAccess::channelInstrumentUpdate | ( | BInt32 | append, |
ChannelInstrument | channelInstrument, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::channelUpdate | ( | BInt32 | append, |
Channel | channel, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::clean | ( | CleanOptions | cleanOptions | ) |
Cleans the system logs and Changes information.
BError Bds::AdminAccess::connect | ( | BString | user, |
BString | password | ||
) |
Provides user/password information.
BError Bds::AdminAccess::databaseBackup | ( | BString & | ref | ) |
Backup the database.
BError Bds::AdminAccess::databaseRestore | ( | BString | ref | ) |
Restore the database.
BError Bds::AdminAccess::dataChannelDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::dataChannelGetList | ( | Selection | sel, |
BList< DataChannel > & | dataChannel | ||
) |
Get list of DataChannels.
BError Bds::AdminAccess::dataChannelUpdate | ( | BInt32 | append, |
DataChannel | dataChannel, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::dataClose | ( | DataHandle | dataHandle, |
BError | error, | ||
BInt32 | del | ||
) |
Close a stream.
BError Bds::AdminAccess::dataFileDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::dataFileGetList | ( | Selection | sel, |
BList< DataFileInfo > & | dataFile | ||
) |
Get list of DataFiles.
BError Bds::AdminAccess::dataFileUpdate | ( | BInt32 | append, |
DataFileInfo | dataFile, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::dataFormatGetList | ( | BList< DataFormat > & | formats | ) |
Get list of data formats.
BError Bds::AdminAccess::dataFormattedGetLength | ( | DataHandle | dataHandle, |
BUInt64 & | length | ||
) |
Read the raw data from the stream.
BError Bds::AdminAccess::dataFormattedRead | ( | DataHandle | dataHandle, |
BUInt32 | number, | ||
BArray< BUInt8 > & | data | ||
) |
Read the raw data from the stream.
BError Bds::AdminAccess::dataGetBlock | ( | DataHandle | dataHandle, |
BUInt32 | channel, | ||
BUInt32 | segment, | ||
BUInt32 | blockNumber, | ||
DataBlock & | data | ||
) |
Return a block of data.
BError Bds::AdminAccess::dataGetChannelInfo | ( | DataInfo | dataInfo, |
ChannelInfos & | channelInfos | ||
) |
Return the channel MetaData in structured form.
BError Bds::AdminAccess::dataGetInfo | ( | DataHandle | dataHandle, |
BUInt32 | infoExtra, | ||
DataInfo & | dataInfo | ||
) |
Get information on the data stream.
BError Bds::AdminAccess::dataGetNotes | ( | DataHandle | dataHandle, |
BList< Note > & | notes | ||
) |
Get notes on the data stream.
BError Bds::AdminAccess::dataGetWarnings | ( | DataHandle | dataHandle, |
BList< BString > & | warnings | ||
) |
Get information on the data stream.
BError Bds::AdminAccess::dataOpen | ( | DataInfo | dataInfo, |
BString | mode, | ||
BString | format, | ||
BUInt32 | flags, | ||
DataHandle & | dataHandle | ||
) |
Open a data stream.
BError Bds::AdminAccess::dataPutBlock | ( | DataHandle | dataHandle, |
DataBlock | data | ||
) |
Send a block of data.
Search for data matching the given selection parameters.
BError Bds::AdminAccess::dataSeekBlock | ( | DataHandle | dataHandle, |
BUInt32 | channel, | ||
BUInt32 | segment, | ||
BTimeStamp | time, | ||
BUInt32 & | blockNumber | ||
) |
Searches for a data block matching the time given.
BError Bds::AdminAccess::dataSetInfo | ( | DataHandle | dataHandle, |
DataInfo | dataInfo | ||
) |
Set the info when writing to a stream.
BError Bds::AdminAccess::digitiserDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::digitiserGet | ( | BUInt32 | id, |
Digitiser & | digitiser | ||
) |
Get list of Channels.
BError Bds::AdminAccess::digitiserUpdate | ( | BInt32 | append, |
Digitiser | digitiser, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::getSelectionInfo | ( | SelectionGroup | group, |
Selection | selectionIn, | ||
SelectionInfo & | selectionInfo | ||
) |
Get selection info.
BError Bds::AdminAccess::getSelections | ( | SelectionGroup | group, |
Selection | selectionIn, | ||
Selection & | selectionOut | ||
) |
Get selection list.
BError Bds::AdminAccess::getVersion | ( | BString & | version, |
BString & | name | ||
) |
Gets the software version and server name.
BError Bds::AdminAccess::groupDelete | ( | BUInt32 | id | ) |
Delete a group entry.
BError Bds::AdminAccess::groupGetList | ( | BList< Group > & | groups | ) |
Get list of groups the user belongs to.
Get list of Groups
BError Bds::AdminAccess::groupUpdate | ( | BInt32 | append, |
Group | group, | ||
BUInt32 & | id | ||
) |
Update or append a group entry.
BError Bds::AdminAccess::locationDelete | ( | BUInt32 | id | ) |
Get list of Station Locations.
BError Bds::AdminAccess::locationUpdate | ( | BInt32 | append, |
Location | location, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::logAppend | ( | BString | type, |
BUInt32 | priority, | ||
BString | subSystem, | ||
BString | title, | ||
BString | description | ||
) |
Append a log item.
BError Bds::AdminAccess::logDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::logUpdate | ( | BInt32 | append, |
Log | log, | ||
BUInt32 & | id | ||
) |
Append a log item.
Changes the system mode from Master to slave.
BError Bds::AdminAccess::modeSnapshotPause | ( | BInt32 | on | ) |
Enables/disables backup synchronisation pause.
BError Bds::AdminAccess::networkDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::networkGetList | ( | BList< Network > & | networks | ) |
Get list of Networks.
BError Bds::AdminAccess::networkUpdate | ( | BInt32 | append, |
Network | network, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::noteDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::noteReadDocument | ( | BUInt32 | id, |
BString & | format, | ||
BArray< BUInt8 > & | data | ||
) |
BError Bds::AdminAccess::noteUpdate | ( | BInt32 | append, |
Note | note, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::noteWriteDocument | ( | BUInt32 | id, |
BString | format, | ||
BArray< BUInt8 > | data | ||
) |
BError Bds::AdminAccess::responseDelete | ( | BUInt32 | id | ) |
Get list of Channels.
BError Bds::AdminAccess::responseUpdate | ( | BInt32 | append, |
Response | response, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::sensorDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::sensorGet | ( | BUInt32 | id, |
Sensor & | sensor | ||
) |
Get list of Channels.
BError Bds::AdminAccess::sensorUpdate | ( | BInt32 | append, |
Sensor | sensor, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::setUser | ( | BString | user, |
BString | |||
) |
Sets user to given name or email.
BError Bds::AdminAccess::setUserReal | ( | ) |
Sets user back to real user.
BError Bds::AdminAccess::sourceDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::sourceGetList | ( | BList< Source > & | sources | ) |
Get list of Sources.
BError Bds::AdminAccess::sourcePriorityDelete | ( | BUInt32 | id | ) |
BError Bds::AdminAccess::sourcePriorityGetList | ( | BList< SourcePriority > & | sourcePrioritys | ) |
Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities.
BError Bds::AdminAccess::sourcePriorityUpdate | ( | BInt32 | append, |
SourcePriority | sourcePriority, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::sourceUpdate | ( | BInt32 | append, |
Source | source, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::sqlQuery | ( | BString | query, |
BList< BDict< BString > > & | result | ||
) |
A low level SQL access function.
BError Bds::AdminAccess::stationDelete | ( | BUInt32 | id | ) |
Get list of Stations.
BError Bds::AdminAccess::stationUpdate | ( | BInt32 | append, |
Station | station, | ||
BUInt32 & | id | ||
) |
BError Bds::AdminAccess::statisticsGet | ( | BDict< BString > & | info | ) |
BError Bds::AdminAccess::transactionEnd | ( | BInt32 | abort | ) |
Ends a set of transactions.
BError Bds::AdminAccess::transactionStart | ( | ) |
Starts a set of transactions.
BError Bds::AdminAccess::userDelete | ( | BUInt32 | id | ) |
Delete a user entry.
BError Bds::AdminAccess::userGet | ( | User & | user | ) |
BError Bds::AdminAccess::userGetGroups | ( | BList< BString > & | groups | ) |
Set user info.
BError Bds::AdminAccess::userGetList | ( | BList< User > & | users | ) |
Get list of Users.
BError Bds::AdminAccess::userSet | ( | User | user | ) |
Get user info.
BError Bds::AdminAccess::userUpdate | ( | BInt32 | append, |
User | user, | ||
BUInt32 & | id | ||
) |
Update or append a user entry.
BError Bds::AdminAccess::validateUser | ( | BString | user, |
BString | |||
) |
Checks the user given name or email.