Account
| BdsApi 2.0.11 |
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. More... | |
| BError | validateUser (BString user, BString email) |
| Checks the user given name or email. More... | |
| BError | setUser (BString user, BString email) |
| Sets user to given name or email. More... | |
| BError | setUserReal () |
| Sets user back to real user. More... | |
| BError | getVersion (BString &version, BString &name) |
| Gets the software version and server name. More... | |
| BError | userGetList (BList< User > &users) |
| Get list of Users. More... | |
| BError | userUpdate (BInt32 append, User user, BUInt32 &id) |
| Update or append a user entry. More... | |
| BError | userDelete (BUInt32 id) |
| Delete a user entry. More... | |
| BError | userGetFromId (BUInt32 id, User &user) |
| BError | userGet (User &user) |
| Get user info given user ID. More... | |
| BError | userSet (User user) |
| Get user info. More... | |
| BError | userGetGroups (BList< BString > &groups) |
| Set user info. More... | |
| BError | groupGetList (BList< Group > &groups) |
| Get list of groups the user belongs to. More... | |
| BError | groupUpdate (BInt32 append, Group group, BUInt32 &id) |
| Update or append a group entry. More... | |
| BError | groupDelete (BUInt32 id) |
| Delete a group entry. More... | |
| BError | accessGroupGetList (BList< AccessGroup > &accessGroups) |
| Get list of AccessGroups. More... | |
| BError | accessGroupUpdate (BInt32 append, AccessGroup group, BUInt32 &id) |
| Update or append an AccessGroup entry. More... | |
| BError | accessGroupDelete (BUInt32 id) |
| Delete an AccessGroup entry. More... | |
| BError | getSelectionInfo (SelectionGroup group, Selection selectionIn, SelectionInfo &selectionInfo) |
| Get selection info. More... | |
| BError | getSelections (SelectionGroup group, Selection selectionIn, Selection &selectionOut) |
| Get selection list. More... | |
| BError | networkGetList (BList< Network > &networks) |
| Get list of Networks. More... | |
| BError | networkUpdate (BInt32 append, Network network, BUInt32 &id) |
| BError | networkDelete (BUInt32 id) |
| BError | stationGetList (Selection sel, BList< Station > &stations) |
| Get list of Stations. More... | |
| BError | stationUpdate (BInt32 append, Station station, BUInt32 &id) |
| BError | stationDelete (BUInt32 id) |
| BError | locationGetList (Selection sel, BList< Location > &locations) |
| Get list of Station Locations. More... | |
| BError | locationUpdate (BInt32 append, Location location, BUInt32 &id) |
| BError | locationDelete (BUInt32 id) |
| BError | channelGetList (Selection sel, BList< Channel > &channels) |
| Get list of Channels. More... | |
| BError | channelGet (BUInt32 id, Channel &channel) |
| Get a channel. More... | |
| BError | channelUpdate (BInt32 append, Channel channel, BUInt32 &id) |
| BError | channelDelete (BUInt32 id) |
| BError | sourceGetList (BList< Source > &sources) |
| Get list of Sources. More... | |
| 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. More... | |
| BError | sourcePriorityUpdate (BInt32 append, SourcePriority sourcePriority, BUInt32 &id) |
| BError | sourcePriorityDelete (BUInt32 id) |
| BError | channelInstrumentGetList (Selection sel, BList< ChannelInstrument > &channelInstruments) |
| Get list of Channel Instruments. More... | |
| BError | channelInstrumentUpdate (BInt32 append, ChannelInstrument channelInstrument, BUInt32 &id) |
| BError | channelInstrumentDelete (BUInt32 id) |
| BError | digitiserGetList (Selection sel, BList< Digitiser > &digitisers) |
| Get list of Channels. More... | |
| 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. More... | |
| 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. More... | |
| BError | calibrationUpdate (BInt32 append, Calibration calibration, BUInt32 &id) |
| BError | calibrationDelete (BUInt32 id) |
| BError | responseGetList (Selection sel, BList< Response > &responses) |
| Get list of Channels. More... | |
| BError | responseUpdate (BInt32 append, Response response, BUInt32 &id) |
| BError | responseDelete (BUInt32 id) |
| BError | dataFileGetList (Selection sel, BList< DataFileInfo > &dataFile) |
| Get list of DataFiles. More... | |
| BError | dataFileUpdate (BInt32 append, DataFileInfo dataFile, BUInt32 &id) |
| BError | dataFileDelete (BUInt32 id) |
| BError | dataChannelGetList (Selection sel, BList< DataChannel > &dataChannel) |
| Get list of DataChannels. More... | |
| BError | dataChannelUpdate (BInt32 append, DataChannel dataChannel, BUInt32 &id) |
| BError | dataChannelDelete (BUInt32 id) |
| BError | dataAvailability (Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans) |
| Return availability for data matching the given selection parameters. More... | |
| BError | dataSearch (Selection selection, DataInfo &dataInfo) |
| Search for data matching the given selection parameters. More... | |
| BError | dataGetChannelInfo (DataInfo dataInfo, ChannelInfos &channelInfos) |
| Return the channel MetaData in structured form. More... | |
| BError | dataOpen (DataInfo dataInfo, BString mode, BString format, BUInt32 flags, DataHandle &dataHandle) |
| Open a data stream. More... | |
| BError | dataGetInfo (DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo) |
| Get information on the data stream. More... | |
| BError | dataGetNotes (DataHandle dataHandle, BList< Note > ¬es) |
| Get notes on the data stream. More... | |
| BError | dataGetWarnings (DataHandle dataHandle, BList< BString > &warnings) |
| Get information on the data stream. More... | |
| BError | dataGetBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BUInt32 blockNumber, DataBlock &data) |
| Return a block of data. More... | |
| BError | dataSeekBlock (DataHandle dataHandle, BUInt32 channel, BUInt32 segment, BTimeStamp time, BUInt32 &blockNumber) |
| Searches for a data block matching the time given. More... | |
| BError | dataSetInfo (DataHandle dataHandle, DataInfo dataInfo) |
| Set the info when writing to a stream. More... | |
| BError | dataPutBlock (DataHandle dataHandle, DataBlock data) |
| Send a block of data. More... | |
| BError | dataClose (DataHandle dataHandle, BError error, BInt32 del) |
| Close a stream. More... | |
| BError | dataFormattedRead (DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data) |
| Read the raw data from the stream. More... | |
| BError | dataFormattedGetLength (DataHandle dataHandle, BUInt64 &length) |
| Read the raw data from the stream. More... | |
| 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. More... | |
| BError | logUpdate (BInt32 append, Log log, BUInt32 &id) |
| Append a log item. More... | |
| BError | logDelete (BUInt32 id) |
| BError | logAppend (BString type, BUInt32 priority, BString subSystem, BString title, BString description) |
| Append a log item. More... | |
| BError | statisticsGet (BDict< BString > &info) |
| BError | dataFormatGetList (BList< DataFormat > &formats) |
| Get list of data formats. More... | |
| BError | transactionStart () |
| Starts a set of transactions. More... | |
| BError | transactionEnd (BInt32 abort) |
| Ends a set of transactions. More... | |
| BError | modeSet (Mode mode, Mode &previousMode) |
| Changes the system mode from Master to slave. More... | |
| BError | modeSnapshotPause (BInt32 on) |
| Enables/disables backup synchronisation pause. More... | |
| BError | clean (CleanOptions cleanOptions) |
| Cleans the system logs and Changes information. More... | |
| BError | databaseBackup (BString &ref) |
| Backup the database. More... | |
| BError | databaseRestore (BString ref, BString type) |
| Restore the database. More... | |
| BError | sqlQuery (BString query, BList< BDict< BString > > &result) |
| A low level SQL access function. More... | |
Public Member Functions inherited from BoapClientObject | |
| BoapClientObject (BString name="") | |
| virtual | ~BoapClientObject () |
| BError | connectService (BString name) |
| BError | disconnectService () |
| BString | getServiceName () |
| BError | ping (BUInt32 &apiVersion) |
| BError | setConnectionPriority (BoapPriority priority) |
| void | setMaxLength (BUInt32 maxLength) |
| void | setTimeout (int timeout) |
| BoapClientObject (BString name) | |
| BError | connectService (BString name) |
Public Member Functions inherited from BSocket | |
| BSocket () | |
| BSocket (int fd) | |
| BSocket (NType type) | |
| BSocket (int domain, int type, int protocol) | |
| ~BSocket () | |
| BError | init (int domain, int type, int protocol) |
| BError | init (NType type) |
| void | setFd (int fd) |
| int | getFd () |
| BError | bind (const BSocketAddress &add) |
| BError | connect (const BSocketAddress &add) |
| BError | shutdown (int how) |
| BError | close () |
| BError | listen (int backlog=5) |
| BError | accept (int &fd) |
| BError | accept (int &fd, BSocketAddress &address) |
| BError | send (const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0) |
| BError | sendTo (const BSocketAddress &address, const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0) |
| BError | sendChunks (const BDataChunk *chunks, BSize nChunks, BSize &nbytesSent, int flags=0) |
| BError | recv (void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0) |
| BError | recvFrom (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0) |
| BError | recvWithTimeout (void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0) |
| BError | recvFromWithTimeout (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0) |
| BUInt | recvAvailable () |
| BError | setSockOpt (int level, int optname, void *optval, unsigned int optlen) |
| BError | getSockOpt (int level, int optname, void *optval, unsigned int *optlen) |
| BError | setReuseAddress (int on) |
| BError | setBroadCast (int on) |
| BError | setPriority (Priority priority) |
| BError | getMTU (uint32_t &mtu) |
| BError | getAddress (BSocketAddress &address) |
Additional Inherited Members | |
Public Types inherited from BSocket | |
| enum | NType |
| enum | Priority |
Public Attributes inherited from BSocket | |
| STREAM | |
| DGRAM | |
| PriorityLow | |
| PriorityNormal | |
| PriorityHigh | |
Protected Member Functions inherited from BoapClientObject | |
| BError | pingLocked (BUInt32 &apiVersion) |
| BError | checkApiVersion () |
| BError | performCall (BoapPacket &tx, BoapPacket &rx) |
| BError | performSend (BoapPacket &tx) |
| BError | performRecv (BoapPacket &rx) |
| virtual BError | handleReconnect (BError err) |
| BError | performSend (BoapPacket &tx) |
| BError | performRecv (BoapPacket &rx) |
| BError | performCall (BoapPacket &tx, BoapPacket &rx) |
Protected Attributes inherited from BoapClientObject | |
| BString | oname |
| BUInt32 | oapiVersion |
| BoapPriority | opriority |
| BoapService | oservice |
| int | oconnected |
| BUInt32 | omaxLength |
| BoapPacket | otx |
| BoapPacket | orx |
| BMutex | olock |
| int | otimeout |
| int | oreconnect |
Detailed Description
This is the AdminAccess API interface.
Constructor & Destructor Documentation
◆ AdminAccess()
| Bds::AdminAccess::AdminAccess | ( | BString | name = "" | ) |
Member Function Documentation
◆ accessGroupDelete()
Delete an AccessGroup entry.
◆ accessGroupGetList()
| BError Bds::AdminAccess::accessGroupGetList | ( | BList< AccessGroup > & | accessGroups | ) |
Get list of AccessGroups.
◆ accessGroupUpdate()
| BError Bds::AdminAccess::accessGroupUpdate | ( | BInt32 | append, |
| AccessGroup | group, | ||
| BUInt32 & | id | ||
| ) |
Update or append an AccessGroup entry.
◆ calibrationDelete()
◆ calibrationGetList()
| BError Bds::AdminAccess::calibrationGetList | ( | Selection | sel, |
| BList< Calibration > & | calibrations | ||
| ) |
Get list of Channels.
◆ calibrationUpdate()
| BError Bds::AdminAccess::calibrationUpdate | ( | BInt32 | append, |
| Calibration | calibration, | ||
| BUInt32 & | id | ||
| ) |
◆ changeDelete()
| BError Bds::AdminAccess::changeDelete | ( | BTimeStamp | beforeDate, |
| BString | type | ||
| ) |
◆ changeGetList()
◆ changeGetListNumber()
◆ changeGroupDelete()
| BError Bds::AdminAccess::changeGroupDelete | ( | BTimeStamp | beforeDate, |
| BString | type, | ||
| BInt32 | empty | ||
| ) |
◆ changeGroupEnd()
| BError Bds::AdminAccess::changeGroupEnd | ( | ) |
◆ changeGroupGetList()
| BError Bds::AdminAccess::changeGroupGetList | ( | ListRange | range, |
| BList< ChangeGroup > & | changeGroups | ||
| ) |
◆ changeGroupStart()
| BError Bds::AdminAccess::changeGroupStart | ( | ChangeGroup | changeGroup | ) |
◆ channelDelete()
◆ channelGet()
◆ channelGetList()
Get list of Channels.
◆ channelInstrumentDelete()
◆ channelInstrumentGetList()
| BError Bds::AdminAccess::channelInstrumentGetList | ( | Selection | sel, |
| BList< ChannelInstrument > & | channelInstruments | ||
| ) |
Get list of Channel Instruments.
◆ channelInstrumentUpdate()
| BError Bds::AdminAccess::channelInstrumentUpdate | ( | BInt32 | append, |
| ChannelInstrument | channelInstrument, | ||
| BUInt32 & | id | ||
| ) |
◆ channelUpdate()
◆ clean()
| BError Bds::AdminAccess::clean | ( | CleanOptions | cleanOptions | ) |
Cleans the system logs and Changes information.
◆ connect()
Provides user/password information.
◆ dataAvailability()
| BError Bds::AdminAccess::dataAvailability | ( | Selection | selection, |
| BUInt32 | num, | ||
| BArray< DataAvailChan > & | dataAvailChans | ||
| ) |
Return availability for data matching the given selection parameters.
◆ databaseBackup()
◆ databaseRestore()
◆ dataChannelDelete()
◆ dataChannelGetList()
| BError Bds::AdminAccess::dataChannelGetList | ( | Selection | sel, |
| BList< DataChannel > & | dataChannel | ||
| ) |
Get list of DataChannels.
◆ dataChannelUpdate()
| BError Bds::AdminAccess::dataChannelUpdate | ( | BInt32 | append, |
| DataChannel | dataChannel, | ||
| BUInt32 & | id | ||
| ) |
◆ dataClose()
| BError Bds::AdminAccess::dataClose | ( | DataHandle | dataHandle, |
| BError | error, | ||
| BInt32 | del | ||
| ) |
Close a stream.
◆ dataFileDelete()
◆ dataFileGetList()
| BError Bds::AdminAccess::dataFileGetList | ( | Selection | sel, |
| BList< DataFileInfo > & | dataFile | ||
| ) |
Get list of DataFiles.
◆ dataFileUpdate()
| BError Bds::AdminAccess::dataFileUpdate | ( | BInt32 | append, |
| DataFileInfo | dataFile, | ||
| BUInt32 & | id | ||
| ) |
◆ dataFormatGetList()
| BError Bds::AdminAccess::dataFormatGetList | ( | BList< DataFormat > & | formats | ) |
Get list of data formats.
◆ dataFormattedGetLength()
| BError Bds::AdminAccess::dataFormattedGetLength | ( | DataHandle | dataHandle, |
| BUInt64 & | length | ||
| ) |
Read the raw data from the stream.
◆ dataFormattedRead()
| BError Bds::AdminAccess::dataFormattedRead | ( | DataHandle | dataHandle, |
| BUInt32 | number, | ||
| BArray< BUInt8 > & | data | ||
| ) |
Read the raw data from the stream.
◆ dataGetBlock()
| BError Bds::AdminAccess::dataGetBlock | ( | DataHandle | dataHandle, |
| BUInt32 | channel, | ||
| BUInt32 | segment, | ||
| BUInt32 | blockNumber, | ||
| DataBlock & | data | ||
| ) |
Return a block of data.
◆ dataGetChannelInfo()
| BError Bds::AdminAccess::dataGetChannelInfo | ( | DataInfo | dataInfo, |
| ChannelInfos & | channelInfos | ||
| ) |
Return the channel MetaData in structured form.
◆ dataGetInfo()
| BError Bds::AdminAccess::dataGetInfo | ( | DataHandle | dataHandle, |
| BUInt32 | infoExtra, | ||
| DataInfo & | dataInfo | ||
| ) |
Get information on the data stream.
◆ dataGetNotes()
| BError Bds::AdminAccess::dataGetNotes | ( | DataHandle | dataHandle, |
| BList< Note > & | notes | ||
| ) |
Get notes on the data stream.
◆ dataGetWarnings()
| BError Bds::AdminAccess::dataGetWarnings | ( | DataHandle | dataHandle, |
| BList< BString > & | warnings | ||
| ) |
Get information on the data stream.
◆ dataOpen()
| BError Bds::AdminAccess::dataOpen | ( | DataInfo | dataInfo, |
| BString | mode, | ||
| BString | format, | ||
| BUInt32 | flags, | ||
| DataHandle & | dataHandle | ||
| ) |
Open a data stream.
◆ dataPutBlock()
| BError Bds::AdminAccess::dataPutBlock | ( | DataHandle | dataHandle, |
| DataBlock | data | ||
| ) |
Send a block of data.
◆ dataSearch()
Search for data matching the given selection parameters.
◆ dataSeekBlock()
| BError Bds::AdminAccess::dataSeekBlock | ( | DataHandle | dataHandle, |
| BUInt32 | channel, | ||
| BUInt32 | segment, | ||
| BTimeStamp | time, | ||
| BUInt32 & | blockNumber | ||
| ) |
Searches for a data block matching the time given.
◆ dataSetInfo()
| BError Bds::AdminAccess::dataSetInfo | ( | DataHandle | dataHandle, |
| DataInfo | dataInfo | ||
| ) |
Set the info when writing to a stream.
◆ digitiserDelete()
◆ digitiserGet()
◆ digitiserGetList()
Get list of Channels.
◆ digitiserUpdate()
◆ getSelectionInfo()
| BError Bds::AdminAccess::getSelectionInfo | ( | SelectionGroup | group, |
| Selection | selectionIn, | ||
| SelectionInfo & | selectionInfo | ||
| ) |
Get selection info.
◆ getSelections()
| BError Bds::AdminAccess::getSelections | ( | SelectionGroup | group, |
| Selection | selectionIn, | ||
| Selection & | selectionOut | ||
| ) |
Get selection list.
◆ getVersion()
Gets the software version and server name.
◆ groupDelete()
◆ groupGetList()
Get list of groups the user belongs to.
Get list of Groups
◆ groupUpdate()
Update or append a group entry.
◆ locationDelete()
◆ locationGetList()
Get list of Station Locations.
◆ locationUpdate()
◆ logAppend()
| BError Bds::AdminAccess::logAppend | ( | BString | type, |
| BUInt32 | priority, | ||
| BString | subSystem, | ||
| BString | title, | ||
| BString | description | ||
| ) |
Append a log item.
◆ logDelete()
◆ logGetList()
◆ logUpdate()
◆ modeSet()
Changes the system mode from Master to slave.
◆ modeSnapshotPause()
Enables/disables backup synchronisation pause.
◆ networkDelete()
◆ networkGetList()
◆ networkUpdate()
◆ noteDelete()
◆ noteGetList()
◆ noteReadDocument()
◆ noteUpdate()
◆ noteWriteDocument()
◆ responseDelete()
◆ responseGetList()
Get list of Channels.
◆ responseUpdate()
◆ sensorDelete()
◆ sensorGet()
◆ sensorGetList()
Get list of Channels.
◆ sensorUpdate()
◆ setUser()
◆ setUserReal()
| BError Bds::AdminAccess::setUserReal | ( | ) |
Sets user back to real user.
◆ sourceDelete()
◆ sourceGetList()
◆ sourcePriorityDelete()
◆ sourcePriorityGetList()
| BError Bds::AdminAccess::sourcePriorityGetList | ( | BList< SourcePriority > & | sourcePrioritys | ) |
Get list of Source Error sourceGetList(out List<Source> sources); ///< Get list of SourcePriorities.
◆ sourcePriorityUpdate()
| BError Bds::AdminAccess::sourcePriorityUpdate | ( | BInt32 | append, |
| SourcePriority | sourcePriority, | ||
| BUInt32 & | id | ||
| ) |
◆ sourceUpdate()
◆ sqlQuery()
A low level SQL access function.
◆ stationDelete()
◆ stationGetList()
Get list of Stations.
◆ stationUpdate()
◆ statisticsGet()
◆ transactionEnd()
◆ transactionStart()
| BError Bds::AdminAccess::transactionStart | ( | ) |
Starts a set of transactions.
◆ userDelete()
◆ userGet()
◆ userGetFromId()
◆ userGetGroups()
◆ userGetList()
◆ userSet()
◆ userUpdate()
Update or append a user entry.
◆ validateUser()
Checks the user given name or email.
The documentation for this class was generated from the following files:
Generated by
1.8.15 
Public Member Functions inherited from