BdsApi
2.2.7
This is the Blacknest BDS API.
|
This is the AdminAccess Access 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) |
Get user info given user ID. More... | |
BError | userGet (User &user) |
Get user info. More... | |
BError | userSet (User user) |
Set user info. More... | |
BError | userGetGroups (BList< BString > &groups) |
Get list of groups the user belongs to. More... | |
BError | groupGetList (BList< Group > &groups) |
Get list of Groups. 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 information on possible selections. Use in GUI programs to list options available. 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) |
Add or update a Network entry. More... | |
BError | networkDelete (BUInt32 id) |
Delete a Network entry. More... | |
BError | stationGetList (Selection sel, BList< Station > &stations) |
Get list of Stations. More... | |
BError | stationUpdate (BInt32 append, Station station, BUInt32 &id) |
Add or update a Station entry. More... | |
BError | stationDelete (BUInt32 id) |
Delete a Station entry. More... | |
BError | locationGetList (Selection sel, BList< Location > &locations) |
Get list of Station Locations. More... | |
BError | locationUpdate (BInt32 append, Location location, BUInt32 &id) |
Add or update a Station Location entry. More... | |
BError | locationDelete (BUInt32 id) |
Delete a Station Location entry. More... | |
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) |
Add or update a Channel entry. More... | |
BError | channelDelete (BUInt32 id) |
Delete a Channel entry. More... | |
BError | sourceGetList (BList< Source > &sources) |
Get list of Sources. More... | |
BError | sourceUpdate (BInt32 append, Source source, BUInt32 &id) |
Add or update a Source entry. More... | |
BError | sourceDelete (BUInt32 id) |
Delete a Source entry. More... | |
BError | sourcePriorityGetList (BList< SourcePriority > &sourcePrioritys) |
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) |
Add or update a Instrument entry. More... | |
BError | channelInstrumentDelete (BUInt32 id) |
Delete an Instrument entry. More... | |
BError | digitiserGetList (Selection sel, BList< Digitiser > &digitisers) |
Get list of Digitisers. More... | |
BError | digitiserGet (BUInt32 id, Digitiser &digitiser) |
Get a Digitiser object given its ID. More... | |
BError | digitiserUpdate (BInt32 append, Digitiser digitiser, BUInt32 &id) |
Add or update a Digitiser entry. More... | |
BError | digitiserDelete (BUInt32 id) |
Delete a Digitiser entry. More... | |
BError | sensorGetList (Selection sel, BList< Sensor > &sensors) |
Get list of Sensors. More... | |
BError | sensorGet (BUInt32 id, Sensor &sensor) |
Get a Sensor object given its ID. More... | |
BError | sensorUpdate (BInt32 append, Sensor sensor, BUInt32 &id) |
Add or update a Sensor entry. More... | |
BError | sensorDelete (BUInt32 id) |
Delete a Sensor entry. More... | |
BError | calibrationGetList (Selection sel, BList< Calibration > &calibrations) |
Get list of Calibrations. More... | |
BError | calibrationUpdate (BInt32 append, Calibration calibration, BUInt32 &id) |
Add or update a Calibration entry. More... | |
BError | calibrationDelete (BUInt32 id) |
Delete a Calibration entry. More... | |
BError | responseGetList (Selection sel, BList< Response > &responses) |
Get list of Responses. More... | |
BError | responseUpdate (BInt32 append, Response response, BUInt32 &id) |
Add or update a Response entry. More... | |
BError | responseDelete (BUInt32 id) |
Delete a Response entry. More... | |
BError | dataFileGetList (Selection sel, BList< DataFileInfo > &dataFile) |
Get list of DataFiles. More... | |
BError | dataFileUpdate (BInt32 append, DataFileInfo dataFile, BUInt32 &id) |
Add or update a DataFile entry. More... | |
BError | dataFileDelete (BUInt32 id) |
Delete a DataFile entry. More... | |
BError | dataChannelGetList (Selection sel, BList< DataChannel > &dataChannel) |
Get list of DataChannels. More... | |
BError | dataChannelUpdate (BInt32 append, DataChannel dataChannel, BUInt32 &id) |
Add or update a DataChannel entry. More... | |
BError | dataChannelDelete (BUInt32 id) |
Delete a DataChannel entry. More... | |
BError | dataAvailability (Selection selection, BUInt32 num, BArray< DataAvailChan > &dataAvailChans) |
Return availability for data matching the given selection parameters. If num > 0 segment ito this number of fixed time segments. 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 file. More... | |
BError | dataGetInfo (DataHandle dataHandle, BUInt32 infoExtra, DataInfo &dataInfo) |
Get information on the data file. More... | |
BError | dataGetNotes (DataHandle dataHandle, BList< Note > ¬es) |
Get notes on the data file. More... | |
BError | dataGetWarnings (DataHandle dataHandle, BList< BString > &warnings) |
Get information on the data file. 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 file. More... | |
BError | dataPutBlock (DataHandle dataHandle, DataBlock data) |
Send a block of data. More... | |
BError | dataClose (DataHandle dataHandle, BError error, BInt32 del) |
Close a file. More... | |
BError | dataFormattedRead (DataHandle dataHandle, BUInt32 number, BArray< BUInt8 > &data) |
Read the raw data from the file. More... | |
BError | dataFormattedGetLength (DataHandle dataHandle, BUInt64 &length) |
Read the raw data from the file. More... | |
BError | changeGroupStart (ChangeGroup changeGroup) |
Start a new ChangeGroup when making a set of changes to the BDS's database. More... | |
BError | changeGroupEnd () |
End a ChangeGroup. More... | |
BError | changeGroupGetList (ListRange range, BList< ChangeGroup > &changeGroups) |
Return a list of ChangeGroups. More... | |
BError | changeGroupDelete (BTimeStamp beforeDate, BString type, BInt32 empty) |
Delete a ChangeGroup. More... | |
BError | changeGetListNumber (BUInt32 id, BUInt32 &number) |
Get the number of changes in a ChangeGroup. More... | |
BError | changeGetList (BUInt32 id, ListRange range, BList< Change > &changes) |
Get a list of Changes. More... | |
BError | changeDelete (BTimeStamp beforeDate, BString type) |
Delete a Change. More... | |
BError | noteGetList (Selection sel, BList< Note > ¬es) |
Get a list of Notes. More... | |
BError | noteUpdate (BInt32 append, Note note, BUInt32 &id) |
Add or update a Note. More... | |
BError | noteDelete (BUInt32 id) |
Delete a Note. More... | |
BError | noteWriteDocument (BUInt32 id, BString format, BArray< BUInt8 > data) |
Given a Note write a document associated with it. More... | |
BError | noteReadDocument (BUInt32 id, BString &format, BArray< BUInt8 > &data) |
Read a document associated with a Note. More... | |
BError | logGetList (LogSelect sel, BList< Log > &logs) |
Get list of log entries. More... | |
BError | logUpdate (BInt32 append, Log log, BUInt32 &id) |
Add or Update a Log item. More... | |
BError | logDelete (BUInt32 id) |
Delete a Log item. More... | |
BError | logAppend (BString type, BUInt32 priority, BString subSystem, BString title, BString description) |
Append a log item. More... | |
BError | statisticsGet (BDict< BString > &info) |
Get a list of system statistics. More... | |
BError | dataFormatGetList (BList< DataFormat > &formats) |
Get list of supported 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... | |
![]() | |
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) |
![]() | |
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 | |
![]() | |
enum | NType |
enum | Priority |
![]() | |
STREAM | |
DGRAM | |
PriorityLow | |
PriorityNormal | |
PriorityHigh | |
![]() | |
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) |
![]() | |
BString | oname |
BUInt32 | oapiVersion |
BoapPriority | opriority |
BoapService | oservice |
int | oconnected |
BUInt32 | omaxLength |
BoapPacket | otx |
BoapPacket | orx |
BMutex | olock |
int | otimeout |
int | oreconnect |
This is the AdminAccess Access API interface.
This object provides the set of API functions that make RPC network calls to a BdsServer. It provides the full unresiticed data access API allowring all data read and write operations to be performed.
Bds::AdminAccess::AdminAccess | ( | BString | name = "" | ) |
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.
Delete a Calibration entry.
BError Bds::AdminAccess::calibrationGetList | ( | Selection | sel, |
BList< Calibration > & | calibrations | ||
) |
Get list of Calibrations.
BError Bds::AdminAccess::calibrationUpdate | ( | BInt32 | append, |
Calibration | calibration, | ||
BUInt32 & | id | ||
) |
Add or update a Calibration entry.
BError Bds::AdminAccess::changeDelete | ( | BTimeStamp | beforeDate, |
BString | type | ||
) |
Delete a Change.
Get a list of Changes.
Get the number of changes in a ChangeGroup.
BError Bds::AdminAccess::changeGroupDelete | ( | BTimeStamp | beforeDate, |
BString | type, | ||
BInt32 | empty | ||
) |
Delete a ChangeGroup.
BError Bds::AdminAccess::changeGroupEnd | ( | ) |
End a ChangeGroup.
BError Bds::AdminAccess::changeGroupGetList | ( | ListRange | range, |
BList< ChangeGroup > & | changeGroups | ||
) |
Return a list of ChangeGroups.
BError Bds::AdminAccess::changeGroupStart | ( | ChangeGroup | changeGroup | ) |
Start a new ChangeGroup when making a set of changes to the BDS's database.
Get list of Channels.
BError Bds::AdminAccess::channelInstrumentGetList | ( | Selection | sel, |
BList< ChannelInstrument > & | channelInstruments | ||
) |
Get list of Channel Instruments.
BError Bds::AdminAccess::channelInstrumentUpdate | ( | BInt32 | append, |
ChannelInstrument | channelInstrument, | ||
BUInt32 & | id | ||
) |
Add or update a Instrument entry.
Add or update a Channel entry.
BError Bds::AdminAccess::clean | ( | CleanOptions | cleanOptions | ) |
Cleans the system logs and Changes information.
Provides user/password information.
BError Bds::AdminAccess::dataAvailability | ( | Selection | selection, |
BUInt32 | num, | ||
BArray< DataAvailChan > & | dataAvailChans | ||
) |
Return availability for data matching the given selection parameters. If num > 0 segment ito this number of fixed time segments.
Delete a DataChannel entry.
BError Bds::AdminAccess::dataChannelGetList | ( | Selection | sel, |
BList< DataChannel > & | dataChannel | ||
) |
Get list of DataChannels.
BError Bds::AdminAccess::dataChannelUpdate | ( | BInt32 | append, |
DataChannel | dataChannel, | ||
BUInt32 & | id | ||
) |
Add or update a DataChannel entry.
BError Bds::AdminAccess::dataClose | ( | DataHandle | dataHandle, |
BError | error, | ||
BInt32 | del | ||
) |
Close a file.
BError Bds::AdminAccess::dataFileGetList | ( | Selection | sel, |
BList< DataFileInfo > & | dataFile | ||
) |
Get list of DataFiles.
BError Bds::AdminAccess::dataFileUpdate | ( | BInt32 | append, |
DataFileInfo | dataFile, | ||
BUInt32 & | id | ||
) |
Add or update a DataFile entry.
BError Bds::AdminAccess::dataFormatGetList | ( | BList< DataFormat > & | formats | ) |
Get list of supported data formats.
BError Bds::AdminAccess::dataFormattedGetLength | ( | DataHandle | dataHandle, |
BUInt64 & | length | ||
) |
Read the raw data from the file.
BError Bds::AdminAccess::dataFormattedRead | ( | DataHandle | dataHandle, |
BUInt32 | number, | ||
BArray< BUInt8 > & | data | ||
) |
Read the raw data from the file.
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 file.
BError Bds::AdminAccess::dataGetNotes | ( | DataHandle | dataHandle, |
BList< Note > & | notes | ||
) |
Get notes on the data file.
BError Bds::AdminAccess::dataGetWarnings | ( | DataHandle | dataHandle, |
BList< BString > & | warnings | ||
) |
Get information on the data file.
BError Bds::AdminAccess::dataOpen | ( | DataInfo | dataInfo, |
BString | mode, | ||
BString | format, | ||
BUInt32 | flags, | ||
DataHandle & | dataHandle | ||
) |
Open a data file.
[in] | dataInfo | The sensor data to open selection |
[in] | mode | The open format. The mode should be set to "w" for writing data, "a" when appending data and "r" for reading data. |
[in] | format | What format to open the data stream as. This can be API for raw BDS API access or one of the supported formats that the BDS is able to convert to. |
[in] | flags | A bitset of flags as defined by Bds::DataFlags. |
[out] | dataHandle | The handle for the open data set |
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 file.
Get a Digitiser object given its ID.
Get list of Digitisers.
Add or update a Digitiser entry.
BError Bds::AdminAccess::getSelectionInfo | ( | SelectionGroup | group, |
Selection | selectionIn, | ||
SelectionInfo & | selectionInfo | ||
) |
Get information on possible selections. Use in GUI programs to list options available.
BError Bds::AdminAccess::getSelections | ( | SelectionGroup | group, |
Selection | selectionIn, | ||
Selection & | selectionOut | ||
) |
Get selection list.
Gets the software version and server name.
Update or append a group entry.
Get list of Station Locations.
BError Bds::AdminAccess::logAppend | ( | BString | type, |
BUInt32 | priority, | ||
BString | subSystem, | ||
BString | title, | ||
BString | description | ||
) |
Append a log item.
Add or Update a Log item.
Changes the system mode from Master to slave.
Enables/disables backup synchronisation pause.
Add or update a Network entry.
Read a document associated with a Note.
Add or update a Note.
Given a Note write a document associated with it.
Get list of Responses.
Add or update a Response entry.
Get a Sensor object given its ID.
Get list of Sensors.
Add or update a Sensor entry.
BError Bds::AdminAccess::setUserReal | ( | ) |
Sets user back to real user.
BError Bds::AdminAccess::sourcePriorityGetList | ( | BList< SourcePriority > & | sourcePrioritys | ) |
Get list of SourcePriorities.
BError Bds::AdminAccess::sourcePriorityUpdate | ( | BInt32 | append, |
SourcePriority | sourcePriority, | ||
BUInt32 & | id | ||
) |
Add or update a Source entry.
A low level SQL access function.
Get list of Stations.
Add or update a Station entry.
BError Bds::AdminAccess::transactionStart | ( | ) |
Starts a set of transactions.
Get list of groups the user belongs to.
Update or append a user entry.
Checks the user given name or email.