\doxysection{Bds\+::Admin\+Access Class Reference}
\hypertarget{classBds_1_1AdminAccess}{}\label{classBds_1_1AdminAccess}\index{Bds::AdminAccess@{Bds::AdminAccess}}


This is the \doxylink{classBds_1_1AdminAccess}{Admin\+Access} Access API interface.  




{\ttfamily \#include $<$Bds\+C.\+h$>$}

Inheritance diagram for Bds\+::Admin\+Access\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classBds_1_1AdminAccess}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classBds_1_1AdminAccess_a2e8ff1302a9b66e7ea54aa2be744b006}{Admin\+Access}} (\textbf{ BString} name=\"{}\"{})
\begin{DoxyCompactList}\small\item\em BDS RPC access class. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ad8a3176f5194d9b048525fca0a71b237}{connect}} (\textbf{ BString} user, \textbf{ BString} password)
\begin{DoxyCompactList}\small\item\em Provides user/password information. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a02c1e5822c26f245f2575c155d31a46e}{validate\+User}} (\textbf{ BString} user, \textbf{ BString} email)
\begin{DoxyCompactList}\small\item\em Checks the user given name or email. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a8b668196050941c8c37a9917c9267886}{set\+User}} (\textbf{ BString} user, \textbf{ BString} email)
\begin{DoxyCompactList}\small\item\em Sets user to given name or email. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a500868d92d1dec842d2e53fbd6eb5b3f}{set\+User\+Real}} ()
\begin{DoxyCompactList}\small\item\em Sets user back to real user. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_af7bbf6fe32d8d0964af927724bc16b69}{get\+Version}} (\textbf{ BString} \&version, \textbf{ BString} \&name)
\begin{DoxyCompactList}\small\item\em Gets the software version and server name. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a7d3612e5a7aa5e2730e7889e63599e7e}{user\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1User}{User}} $>$ \&users)
\begin{DoxyCompactList}\small\item\em Get list of Users. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a573fbc14a1859648daef40714eddd79e}{user\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1User}{User}} user, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Update or append a user entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a3fbd7ebc384f87949096ae4944377d58}{user\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a user entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a8c1511c9fb9b3c33eac7b4e39177825e}{user\+Get\+From\+Id}} (\textbf{ BUInt32} id, \mbox{\hyperlink{classBds_1_1User}{User}} \&user)
\begin{DoxyCompactList}\small\item\em Get user info given user ID. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_afd83b2fc68d76ff1a1f93dbd44513e78}{user\+Get}} (\mbox{\hyperlink{classBds_1_1User}{User}} \&user)
\begin{DoxyCompactList}\small\item\em Get user info of the currently loogged in user. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac7b272a92ccaa8ac47d07f738856a10f}{user\+Set}} (\mbox{\hyperlink{classBds_1_1User}{User}} user)
\begin{DoxyCompactList}\small\item\em Set user info of the currently loogged in user. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a9c228f9908e0229c8ac02e06b8c7f743}{user\+Get\+Groups}} (\textbf{ BList}$<$ \textbf{ BString} $>$ \&groups)
\begin{DoxyCompactList}\small\item\em Get list of groups the user belongs to. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a437a9f4b46b894c775e516628cfff211}{user\+Get\+Options}} (\textbf{ BDict}$<$ \textbf{ BString} $>$ \&items)
\begin{DoxyCompactList}\small\item\em Get users options. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a420974a01627655b0ae38a3adb9b7898}{user\+Set\+Options}} (\textbf{ BDict}$<$ \textbf{ BString} $>$ \&items)
\begin{DoxyCompactList}\small\item\em Set users options. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a379feb7d9423a834f005009236fe2862}{group\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Group}{Group}} $>$ \&groups)
\begin{DoxyCompactList}\small\item\em Get list of Groups. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6f3a74eda3d4f98aaf5ae54d7b626906}{group\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Group}{Group}} group, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Update or append a group entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a8c19cab7376ed783a4b937ae013fc3b6}{group\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a group entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a0f2c4892f6a6d2088cec044c85a9a0b8}{access\+Group\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1AccessGroup}{Access\+Group}} $>$ \&access\+Groups)
\begin{DoxyCompactList}\small\item\em Get list of Access\+Groups. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a89f9efe4b645b41af2a3403d0011da55}{access\+Group\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1AccessGroup}{Access\+Group}} group, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Update or append an \doxylink{classBds_1_1AccessGroup}{Access\+Group} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a5b7eb357ce645c4fcdf4363d17b01ec3}{access\+Group\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete an \doxylink{classBds_1_1AccessGroup}{Access\+Group} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_afcc1318b4452af19a6789ab59d2105bc}{get\+Selection\+Info}} (\mbox{\hyperlink{namespaceBds_abde7774a9183d612e43055b51841928b}{Selection\+Group}} group, \mbox{\hyperlink{classBds_1_1Selection}{Selection}} selection\+In, \mbox{\hyperlink{classBds_1_1SelectionInfo}{Selection\+Info}} \&selection\+Info)
\begin{DoxyCompactList}\small\item\em Get information on possible selections. Use in GUI programs to list options available. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a0e925c6d680b336c0e78505c200f06e6}{get\+Selections}} (\mbox{\hyperlink{namespaceBds_abde7774a9183d612e43055b51841928b}{Selection\+Group}} group, \mbox{\hyperlink{classBds_1_1Selection}{Selection}} selection\+In, \mbox{\hyperlink{classBds_1_1Selection}{Selection}} \&selection\+Out)
\begin{DoxyCompactList}\small\item\em Get selection list. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a936ba1aa568292b2f1eaefa2e8380076}{network\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Network}{Network}} $>$ \&networks)
\begin{DoxyCompactList}\small\item\em Get list of Networks. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ad04bfae9787facff173aaa9efd02afd8}{network\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Network}{Network}} network, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Network}{Network} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_abb6c06122a9e054c38c62917587da52e}{network\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Network}{Network} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a669b29096bdcf45a2b18a485d0e5838a}{station\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Station}{Station}} $>$ \&stations)
\begin{DoxyCompactList}\small\item\em Get list of Stations. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a2bd2c40245d14534817981654eb6875f}{station\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Station}{Station}} station, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Station}{Station} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6cdbcceabd7e0be7569f26dce918588e}{station\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Station}{Station} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a3cbcbec0b9a7ee6751eea781d2884472}{location\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Location}{Location}} $>$ \&locations)
\begin{DoxyCompactList}\small\item\em Get list of \doxylink{classBds_1_1Station}{Station}, \doxylink{classBds_1_1Channel}{Channel} or both Locations depending on the sel.\+location\+Select parameter. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a067bb79106c6dbcee4bc0ae2adce9d0a}{location\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Location}{Location}} location, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Station}{Station} \doxylink{classBds_1_1Location}{Location} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aaa8fcb017dac79dda2c1b91800f77493}{location\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Station}{Station} \doxylink{classBds_1_1Location}{Location} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a316f7336a520eaba284e378696201389}{channel\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Channel}{Channel}} $>$ \&channels)
\begin{DoxyCompactList}\small\item\em Get list of Channels. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ae525aaea542a996370daebdd9fc2c39f}{channel\+Get}} (\textbf{ BUInt32} id, \mbox{\hyperlink{classBds_1_1Channel}{Channel}} \&channel)
\begin{DoxyCompactList}\small\item\em Get a specific channel given its ID. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aa82fd8f10089bed8917315795ef87960}{channel\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Channel}{Channel}} channel, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Channel}{Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a50dd476644bd2ab40c3dd0eb11bed0f3}{channel\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Channel}{Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aebad66047693c0546b104f87a2f7e952}{source\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Source}{Source}} $>$ \&sources)
\begin{DoxyCompactList}\small\item\em Get list of Sources. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a91b5dfacfc001902b163138fa21a0a03}{source\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Source}{Source}} source, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Source}{Source} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac4fc262c14a77037cfea4e4228faba1c}{source\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Source}{Source} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a391c07fd9718efc7952b941ae5731871}{source\+Priority\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SourcePriority}{Source\+Priority}} $>$ \&source\+Prioritys)
\begin{DoxyCompactList}\small\item\em Get list of Source\+Priorities. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_abeab3d9fe04cfba5b784c10963148bf7}{source\+Priority\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1SourcePriority}{Source\+Priority}} source\+Priority, \textbf{ BUInt32} \&id)
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a07eded6056c260eef9c3b575dfae980f}{source\+Priority\+Delete}} (\textbf{ BUInt32} id)
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a2b717eba321673093d2e5c89ffebf94c}{channel\+Instrument\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1ChannelInstrument}{Channel\+Instrument}} $>$ \&channel\+Instruments)
\begin{DoxyCompactList}\small\item\em Get list of \doxylink{classBds_1_1Channel}{Channel} Instruments. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_afafcf9d6d45c8c2ef15e4a4d0f88d437}{channel\+Instrument\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1ChannelInstrument}{Channel\+Instrument}} channel\+Instrument, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a Instrument entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aea089d4fd7e012e8ff5c8cc429774726}{channel\+Instrument\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete an Instrument entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ab8a943d027cb5bde9542fe1bba03afca}{digitiser\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}} $>$ \&digitisers)
\begin{DoxyCompactList}\small\item\em Get list of Digitisers. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ad939f1cee2294695c001500a29ffef6a}{digitiser\+Get}} (\textbf{ BUInt32} id, \mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}} \&digitiser)
\begin{DoxyCompactList}\small\item\em Get a \doxylink{classBds_1_1Digitiser}{Digitiser} object given its ID. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aec00d8095f13fdd9f18b24f85fdad496}{digitiser\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}} digitiser, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Digitiser}{Digitiser} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a20b07112982dcb06c3b643e80139a72f}{digitiser\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Digitiser}{Digitiser} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aaf20f92ef7403f83896f8f515c009da0}{sensor\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Sensor}{Sensor}} $>$ \&sensors)
\begin{DoxyCompactList}\small\item\em Get list of Sensors. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ae84e3943a4ead17cbbe4b3cb068749d2}{sensor\+Get}} (\textbf{ BUInt32} id, \mbox{\hyperlink{classBds_1_1Sensor}{Sensor}} \&sensor)
\begin{DoxyCompactList}\small\item\em Get a \doxylink{classBds_1_1Sensor}{Sensor} object given its ID. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a645b0774712d33f6c37d96b229b00066}{sensor\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Sensor}{Sensor}} sensor, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Sensor}{Sensor} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6a19702a348da61c3fc8f2291581057b}{sensor\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Sensor}{Sensor} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a0c050b7a6d37afa2d19ba0f85b37199c}{calibration\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Calibration}{Calibration}} $>$ \&calibrations)
\begin{DoxyCompactList}\small\item\em Get list of Calibrations. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a0e696b22ec309cbd934841175b94dfc5}{calibration\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Calibration}{Calibration}} calibration, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Calibration}{Calibration} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a39f2696f425d1ec481aa1f443141bbfd}{calibration\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Calibration}{Calibration} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6a2ef1ae1e7ed0f9370b15da0e6bd8dd}{response\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Response}{Response}} $>$ \&responses)
\begin{DoxyCompactList}\small\item\em Get list of Responses. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ae86eb50abc4e338e9e4dbcec9bf5a657}{response\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Response}{Response}} response, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Response}{Response} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a47a92a9dc165c2adaf99bb96e6c557ee}{response\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Response}{Response} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a5ed219172e5ab0e05cad80f260a13208}{event\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Event}{Event}} $>$ \&events)
\begin{DoxyCompactList}\small\item\em Get list of Events. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ab37982f588960922eff13f6fc27b4a06}{event\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Event}{Event}} event, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Event}{Event} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a9fb7a9dae2040ac6ea24cc6fd421941f}{event\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Event}{Event} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a7fe777ae76e23c82db532d27c97cd240}{special\+Channel\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SpecialChannel}{Special\+Channel}} $>$ \&special\+Channels)
\begin{DoxyCompactList}\small\item\em Get list of Special Channels. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac2181b8d16f439729ce7d2f0ff12c49c}{special\+Channel\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1SpecialChannel}{Special\+Channel}} special\+Channel, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1SpecialChannel}{Special\+Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_abeb8a9e36852fb7da799047bb6702705}{special\+Channel\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1SpecialChannel}{Special\+Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a000e07899d07984217b8cf46913808a8}{metadata\+Get\+Channel\+Info}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \mbox{\hyperlink{namespaceBds_a55a3947d34c5a2ac3e8e9292efcb432d}{Metadata\+Option}} options, \mbox{\hyperlink{classBds_1_1ChannelInfos}{Channel\+Infos}} \&channel\+Infos)
\begin{DoxyCompactList}\small\item\em Return the channel Meta\+Data in structured form. Normally returns an error if incomplete metadata. If option Allow\+Incomplete is set will return partial Metadata with Error\+Warning. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_af97c277243c8fc6d97e95d0b9eddb715}{metadata\+Get\+Formatted}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \mbox{\hyperlink{namespaceBds_a55a3947d34c5a2ac3e8e9292efcb432d}{Metadata\+Option}} options, \textbf{ BString} \textbf{ format}, \textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&\textbf{ data})
\begin{DoxyCompactList}\small\item\em Return the channel Meta\+Data in a particular format. Normally returns an error if incomplete metadata. If option Allow\+Incomplete is set will return partial Metadata with Error\+Warning. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a46165d019ce7de35f676d1ec0fb0f52a}{data\+File\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataFileInfo}{Data\+File\+Info}} $>$ \&data\+File)
\begin{DoxyCompactList}\small\item\em Get list of Data\+Files. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aa05963bbcac3c79634434899e95f9e10}{data\+File\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1DataFileInfo}{Data\+File\+Info}} data\+File, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1DataFile}{Data\+File} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a9149d47b0d0531bcf963f11af74a6b81}{data\+File\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1DataFile}{Data\+File} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a977aef8899022acc98746553b0a9a430}{data\+Channel\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataChannel}{Data\+Channel}} $>$ \&data\+Channel)
\begin{DoxyCompactList}\small\item\em Get list of Data\+Channels. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a40c1eaa06941f611f067f89082bc4e48}{data\+Channel\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1DataChannel}{Data\+Channel}} data\+Channel, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1DataChannel}{Data\+Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6899caaa4f43ef3ac09f136d19961e6b}{data\+Channel\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1DataChannel}{Data\+Channel} entry. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a8117c6038a5ad43c2f2157171795ed1f}{data\+Availability}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} selection, \textbf{ BUInt32} num, \textbf{ BArray}$<$ \mbox{\hyperlink{classBds_1_1DataAvailChan}{Data\+Avail\+Chan}} $>$ \&data\+Avail\+Chans)
\begin{DoxyCompactList}\small\item\em Return availability for data matching the given selection parameters. If num \texorpdfstring{$>$}{>} 0 segment ito this number of fixed time segments. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac405aa58aecc7606513db8fb9fbc658a}{data\+Search}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} selection, \mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} \&data\+Info)
\begin{DoxyCompactList}\small\item\em Search for data matching the given selection parameters. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aa2173246bd8b5a326e9e2df9c51af451}{data\+Get\+Channel\+Info}} (\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} data\+Info, \mbox{\hyperlink{classBds_1_1ChannelInfos}{Channel\+Infos}} \&channel\+Infos)
\begin{DoxyCompactList}\small\item\em Return the channel Meta\+Data in structured form. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6d8b3a8edaea4a40a21d33fb0f61b73d}{data\+Open}} (\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} data\+Info, \textbf{ BString} mode, \textbf{ BString} \textbf{ format}, \textbf{ BUInt32} flags, \mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} \&data\+Handle)
\begin{DoxyCompactList}\small\item\em Open a data file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a48f32ea2e58391b305e6452b0edbb87e}{data\+Get\+Info}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BUInt32} info\+Extra, \mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} \&data\+Info)
\begin{DoxyCompactList}\small\item\em Get information on the data file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aab1cbfa7170bee06c4c00888546114fe}{data\+Get\+Notes}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Note}{Note}} $>$ \&notes)
\begin{DoxyCompactList}\small\item\em Get notes on the data file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a24e6d4e0d2f76bf027f76f977cd57569}{data\+Get\+Warnings}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BList}$<$ \textbf{ BString} $>$ \&warnings)
\begin{DoxyCompactList}\small\item\em Get information on the data file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a80ebc0650d5ac47b4b785741e4a250c0}{data\+Get\+Block}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BUInt32} channel, \textbf{ BUInt32} segment, \textbf{ BUInt32} block\+Number, \mbox{\hyperlink{classBds_1_1DataBlock}{Data\+Block}} \&\textbf{ data})
\begin{DoxyCompactList}\small\item\em Return a block of data. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a73c88802e602cf654790b8d9e49f685f}{data\+Seek\+Block}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BUInt32} channel, \textbf{ BUInt32} segment, \textbf{ BTime\+Stamp} time, \textbf{ BUInt32} \&block\+Number)
\begin{DoxyCompactList}\small\item\em Searches for a data block matching the time given. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ab51a6f3a251844be8b2af02a466af746}{data\+Set\+Info}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} data\+Info)
\begin{DoxyCompactList}\small\item\em Set the info when writing to a file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a55dab7d6b3773a1ac6e3cf1a90529b92}{data\+Put\+Block}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \mbox{\hyperlink{classBds_1_1DataBlock}{Data\+Block}} \textbf{ data})
\begin{DoxyCompactList}\small\item\em Send a block of data. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a1cf4a104015f196cfa9c2a886ea0ec59}{data\+Close}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BError} \textbf{ error}, \textbf{ BInt32} del)
\begin{DoxyCompactList}\small\item\em Close a file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_afd4b0730ea5ad0b0e04c848e96d10ad7}{data\+Formatted\+Read}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BUInt32} \textbf{ number}, \textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&\textbf{ data})
\begin{DoxyCompactList}\small\item\em Read the raw data from the file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_af0a1b37a47a34329b72b736cf56bc26e}{data\+Formatted\+Get\+Length}} (\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} data\+Handle, \textbf{ BUInt64} \&\textbf{ length})
\begin{DoxyCompactList}\small\item\em Read the length of the raw formated data file. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac2698b7b92146194283ef739085bbc88}{data\+Realtime\+Config}} (\textbf{ BInt32} enable, \mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel)
\begin{DoxyCompactList}\small\item\em Configures the sending of real-\/time data blocks. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a96d68574d5b4ba322aebf09bb6b3bdad}{data\+Realtime\+Get}} (\textbf{ BUInt32} num\+Blocks, \textbf{ BUInt32} \&num\+Blocks\+Available, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataBlockChannel}{Data\+Block\+Channel}} $>$ \&data\+Blocks)
\begin{DoxyCompactList}\small\item\em Returns the number of data blocks available and up to num\+Blocks of these. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a629063fc0e0b9c5ddd0677b4bda9c851}{change\+Group\+Start}} (\mbox{\hyperlink{classBds_1_1ChangeGroup}{Change\+Group}} change\+Group)
\begin{DoxyCompactList}\small\item\em Start a new \doxylink{classBds_1_1ChangeGroup}{Change\+Group} when making a set of changes to the BDS\textquotesingle{}s database. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_abf50eb7764f6e2a5e6a35c15f0c63de5}{change\+Group\+End}} ()
\begin{DoxyCompactList}\small\item\em End a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac70566cb877ad18da55b9f0d6a11dce5}{change\+Group\+Get\+List}} (\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}} range, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1ChangeGroup}{Change\+Group}} $>$ \&change\+Groups)
\begin{DoxyCompactList}\small\item\em Return a list of Change\+Groups. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a3f03baad3d0ebcff20f7021877626b2e}{change\+Group\+Delete}} (\textbf{ BTime\+Stamp} before\+Date, \textbf{ BString} type, \textbf{ BInt32} empty)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a5ed9e7f88162aea5cc388a663fd4e903}{change\+Get\+List\+Number}} (\textbf{ BUInt32} id, \textbf{ BUInt32} \&\textbf{ number})
\begin{DoxyCompactList}\small\item\em Get the number of changes in a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a50537967423af3565522354a52d9e89f}{change\+Get\+List}} (\textbf{ BUInt32} id, \mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}} range, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Change}{Change}} $>$ \&changes)
\begin{DoxyCompactList}\small\item\em Get a list of Changes. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a2683118910835c852ff692a3505ce8aa}{change\+Delete}} (\textbf{ BTime\+Stamp} before\+Date, \textbf{ BString} type)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Change}{Change}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a509afe69b74e77e26f6f6d9fc414144f}{note\+Get\+List}} (\mbox{\hyperlink{classBds_1_1Selection}{Selection}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Note}{Note}} $>$ \&notes)
\begin{DoxyCompactList}\small\item\em Get a list of Notes. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac94c6e7526cca5b56c6c30e916aa9229}{note\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Note}{Note}} note, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or update a \doxylink{classBds_1_1Note}{Note}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_aa15bf3a7c1f29126e92d8699f63a005e}{note\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Note}{Note}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a43cb5aefbefd586757f5c505ee866102}{note\+Write\+Document}} (\textbf{ BUInt32} id, \textbf{ BString} \textbf{ format}, \textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \textbf{ data})
\begin{DoxyCompactList}\small\item\em Given a \doxylink{classBds_1_1Note}{Note} write a document associated with it. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a88a9f40483edfb9bb85b4edcbafcba6c}{note\+Read\+Document}} (\textbf{ BUInt32} id, \textbf{ BString} \&\textbf{ format}, \textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&\textbf{ data})
\begin{DoxyCompactList}\small\item\em Read a document associated with a \doxylink{classBds_1_1Note}{Note}. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a8b2ce1e49c565088521101632d221020}{notices\+Add}} (\textbf{ BString} notice)
\begin{DoxyCompactList}\small\item\em Add a notice line. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_acfa08395e2025506757078204e543375}{notices\+Get\+List}} (\textbf{ BList}$<$ \textbf{ BString} $>$ \&notices)
\begin{DoxyCompactList}\small\item\em Get notices list. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a7f7ef53239353e7c2d99e261b26a4d24}{notices\+Clear}} ()
\begin{DoxyCompactList}\small\item\em Clear notices list. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a1b4e471b3eb816258572175033338349}{log\+Get\+List}} (\mbox{\hyperlink{classBds_1_1LogSelect}{Log\+Select}} sel, \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Log}{Log}} $>$ \&logs)
\begin{DoxyCompactList}\small\item\em Get list of log entries. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a92f626d6a4d147463349d56195bd84d2}{log\+Update}} (\textbf{ BInt32} append, \mbox{\hyperlink{classBds_1_1Log}{Log}} log, \textbf{ BUInt32} \&id)
\begin{DoxyCompactList}\small\item\em Add or Update a \doxylink{classBds_1_1Log}{Log} item. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a634d0a2a4a4fe188209b838b9874ba4d}{log\+Delete}} (\textbf{ BUInt32} id)
\begin{DoxyCompactList}\small\item\em Delete a \doxylink{classBds_1_1Log}{Log} item. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a470e7a2b523f72527f6344d508f0ba8b}{log\+Append}} (\textbf{ BString} type, \textbf{ BUInt32} priority, \textbf{ BString} sub\+System, \textbf{ BString} title, \textbf{ BString} description)
\begin{DoxyCompactList}\small\item\em Append a log item. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ab93d516186974931af8d997cd97ecd23}{statistics\+Get}} (\textbf{ BDict}$<$ \textbf{ BString} $>$ \&info)
\begin{DoxyCompactList}\small\item\em Get a list of system statistics. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a4bc413cbcaa10727a095fbde3b23ad90}{server\+Configuration\+Get}} (\textbf{ BDict}$<$ \textbf{ BString} $>$ \&items)
\begin{DoxyCompactList}\small\item\em Get server configuration parameters. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a25076bbd461330365cc8b2f972cc2f2c}{data\+Format\+Get\+List}} (\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataFormat}{Data\+Format}} $>$ \&formats)
\begin{DoxyCompactList}\small\item\em Get list of supported data formats. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a900c3fc32e525b60068bde736326c853}{transaction\+Start}} ()
\begin{DoxyCompactList}\small\item\em Starts a set of transactions. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a6c8313fbc0b2b2608420241133d53c42}{transaction\+End}} (\textbf{ BInt32} abort)
\begin{DoxyCompactList}\small\item\em Ends a set of transactions. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a43327c4da01b21ccfc69653b51d0fecd}{mode\+Set}} (\mbox{\hyperlink{namespaceBds_a857f94be30ca469ff69522b2881bb064}{Mode}} mode, \mbox{\hyperlink{namespaceBds_a857f94be30ca469ff69522b2881bb064}{Mode}} \&previous\+Mode)
\begin{DoxyCompactList}\small\item\em Changes the system mode from Master to slave. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_adb9c248e38a51faad8ea94cf41e41aa2}{mode\+Snapshot\+Pause}} (\textbf{ BInt32} on)
\begin{DoxyCompactList}\small\item\em Enables/disables backup synchronisation pause. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac80013cf73e7bc0c7369e7c26eb9c0db}{clean}} (\mbox{\hyperlink{classBds_1_1CleanOptions}{Clean\+Options}} clean\+Options)
\begin{DoxyCompactList}\small\item\em Cleans the system logs and Changes information. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a3f3ebd476bf139b7e9039a223ce96d4e}{database\+Backup}} (\textbf{ BString} \&ref)
\begin{DoxyCompactList}\small\item\em Backup the database. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_ac92aecbfb98cdd5f29a7261eb9eb0c1c}{database\+Restore}} (\textbf{ BString} ref, \textbf{ BString} type)
\begin{DoxyCompactList}\small\item\em Restore the database. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a82c95f22c7b70a80402c3bb8cd885d79}{sql\+Query}} (\textbf{ BString} query, \textbf{ BList}$<$ \textbf{ BDict}$<$ \textbf{ BString} $>$ $>$ \&result)
\begin{DoxyCompactList}\small\item\em A low level SQL access function. \end{DoxyCompactList}\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1AdminAccess_a1dfc73b5bc7b36c856d95f36f9099a6e}{extra\+Call}} (\textbf{ BUInt32} function, \textbf{ BString} args, \textbf{ BString} \&result)
\begin{DoxyCompactList}\small\item\em A special function to add new functions to the API prior to a full API update. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \textbf{ Boap\+Client\+Object}}
\begin{DoxyCompactItemize}
\item 
\textbf{ Boap\+Client\+Object} (\textbf{ BString} name=\"{}\"{})
\item 
virtual \textbf{ \texorpdfstring{$\sim$}{\string~}\+Boap\+Client\+Object} ()
\item 
\textbf{ BUInt32} \textbf{ api\+Version} ()
\item 
\textbf{ BError} \textbf{ connect\+Service} (\textbf{ BString} name)
\item 
\textbf{ BError} \textbf{ disconnect\+Service} ()
\item 
\textbf{ BString} \textbf{ get\+Service\+Name} ()
\item 
\textbf{ BError} \textbf{ ping} (\textbf{ BUInt32} \&\textbf{ api\+Version})
\item 
\textbf{ BError} \textbf{ set\+Connection\+Priority} (\textbf{ Boap\+Priority} priority)
\item 
void \textbf{ set\+Max\+Length} (\textbf{ BUInt32} max\+Length)
\item 
void \textbf{ set\+Timeout} (int timeout)
\item 
\textbf{ Boap\+Client\+Object} (\textbf{ BString} name)
\item 
\textbf{ BError} \textbf{ connect\+Service} (\textbf{ BString} name)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \textbf{ BSocket}}
\begin{DoxyCompactItemize}
\item 
\textbf{ BSocket} ()
\item 
\textbf{ BSocket} (int fd)
\item 
\textbf{ BSocket} (\textbf{ NType} type)
\item 
\textbf{ BSocket} (int domain, int type, int protocol)
\item 
\textbf{ \texorpdfstring{$\sim$}{\string~}\+BSocket} ()
\item 
\textbf{ BError} \textbf{ init} (int domain, int type, int protocol)
\item 
\textbf{ BError} \textbf{ init} (\textbf{ NType} type)
\item 
void \textbf{ set\+Fd} (int fd)
\item 
int \textbf{ get\+Fd} ()
\item 
\textbf{ BError} \textbf{ bind} (const \textbf{ BSocket\+Address} \&add)
\item 
\textbf{ BError} \textbf{ connect} (const \textbf{ BSocket\+Address} \&add)
\item 
\textbf{ BError} \textbf{ shutdown} (int how)
\item 
\textbf{ BError} \textbf{ close} ()
\item 
\textbf{ BError} \textbf{ listen} (int backlog=5)
\item 
\textbf{ BError} \textbf{ accept} (int \&fd)
\item 
\textbf{ BError} \textbf{ accept} (int \&fd, \textbf{ BSocket\+Address} \&\textbf{ address})
\item 
\textbf{ BError} \textbf{ send} (const void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} nbytes, \textbf{ BSize} \&nbytes\+Sent, int flags=0)
\item 
\textbf{ BError} \textbf{ send\+To} (const \textbf{ BSocket\+Address} \&\textbf{ address}, const void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} nbytes, \textbf{ BSize} \&nbytes\+Sent, int flags=0)
\item 
\textbf{ BError} \textbf{ send\+Chunks} (const \textbf{ BData\+Chunk} \texorpdfstring{$\ast$}{*}chunks, \textbf{ BSize} n\+Chunks, \textbf{ BSize} \&nbytes\+Sent, int flags=0)
\item 
\textbf{ BError} \textbf{ recv} (void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} maxbytes, \textbf{ BSize} \&nbytes\+Recv, int flags=0)
\item 
\textbf{ BError} \textbf{ recv\+From} (\textbf{ BSocket\+Address} \&\textbf{ address}, void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} maxbytes, \textbf{ BSize} \&nbytes\+Recv, int flags=0)
\item 
\textbf{ BError} \textbf{ recv\+With\+Timeout} (void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} maxbytes, \textbf{ BSize} \&nbytes\+Recv, int timeout, int flags=0)
\item 
\textbf{ BError} \textbf{ recv\+From\+With\+Timeout} (\textbf{ BSocket\+Address} \&\textbf{ address}, void \texorpdfstring{$\ast$}{*}buf, \textbf{ BSize} maxbytes, \textbf{ BSize} \&nbytes\+Recv, int timeout, int flags=0)
\item 
\textbf{ BUInt} \textbf{ recv\+Available} ()
\item 
\textbf{ BError} \textbf{ set\+Sock\+Opt} (int level, int optname, void \texorpdfstring{$\ast$}{*}optval, unsigned int optlen)
\item 
\textbf{ BError} \textbf{ get\+Sock\+Opt} (int level, int optname, void \texorpdfstring{$\ast$}{*}optval, unsigned int \texorpdfstring{$\ast$}{*}optlen)
\item 
\textbf{ BError} \textbf{ set\+Reuse\+Address} (int on)
\item 
\textbf{ BError} \textbf{ set\+Broad\+Cast} (int on)
\item 
\textbf{ BError} \textbf{ set\+Priority} (\textbf{ Priority} priority)
\item 
\textbf{ BError} \textbf{ get\+MTU} (uint32\+\_\+t \&mtu)
\item 
\textbf{ BError} \textbf{ get\+Address} (\textbf{ BSocket\+Address} \&\textbf{ address})
\end{DoxyCompactItemize}
\doxysubsubsection*{Additional Inherited Members}
\doxysubsection*{Public Types inherited from \textbf{ BSocket}}
\begin{DoxyCompactItemize}
\item 
enum {\bfseries NType} 
\item 
enum {\bfseries Priority} 
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes inherited from \textbf{ BSocket}}
\begin{DoxyCompactItemize}
\item 
\textbf{ STREAM}
\item 
\textbf{ DGRAM}
\item 
\textbf{ Priority\+Low}
\item 
\textbf{ Priority\+Normal}
\item 
\textbf{ Priority\+High}
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions inherited from \textbf{ Boap\+Client\+Object}}
\begin{DoxyCompactItemize}
\item 
\textbf{ BError} \textbf{ ping\+Locked} (\textbf{ BUInt32} \&\textbf{ api\+Version})
\item 
\textbf{ BError} \textbf{ check\+Api\+Version} ()
\item 
\textbf{ BError} \textbf{ perform\+Call} (\textbf{ Boap\+Packet} \&tx, \textbf{ Boap\+Packet} \&rx)
\item 
\textbf{ BError} \textbf{ perform\+Send} (\textbf{ Boap\+Packet} \&tx)
\item 
\textbf{ BError} \textbf{ perform\+Recv} (\textbf{ Boap\+Packet} \&rx)
\item 
virtual \textbf{ BError} \textbf{ handle\+Reconnect} (\textbf{ BError} err)
\item 
\textbf{ BError} \textbf{ perform\+Send} (\textbf{ Boap\+Packet} \&tx)
\item 
\textbf{ BError} \textbf{ perform\+Recv} (\textbf{ Boap\+Packet} \&rx)
\item 
\textbf{ BError} \textbf{ perform\+Call} (\textbf{ Boap\+Packet} \&tx, \textbf{ Boap\+Packet} \&rx)
\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes inherited from \textbf{ Boap\+Client\+Object}}
\begin{DoxyCompactItemize}
\item 
\textbf{ BString} \textbf{ oname}
\item 
\textbf{ BUInt32} \textbf{ oapi\+Version}
\item 
\textbf{ Boap\+Priority} \textbf{ opriority}
\item 
\textbf{ Boap\+Service} \textbf{ oservice}
\item 
int \textbf{ oconnected}
\item 
\textbf{ BUInt32} \textbf{ omax\+Length}
\item 
\textbf{ Boap\+Packet} \textbf{ otx}
\item 
\textbf{ Boap\+Packet} \textbf{ orx}
\item 
\textbf{ BMutex} \textbf{ olock}
\item 
int \textbf{ otimeout}
\item 
int \textbf{ oreconnect}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This is the \doxylink{classBds_1_1AdminAccess}{Admin\+Access} Access API interface. 

This object provides the set of API functions that make RPC network calls to a Bds\+Server. It provides the full unresiticed data access API allowring all data read and write operations to be performed.

To use this Bds\+Server access object you would create one like \"{}\+Data\+Access bds;\"{}. Then you would connect it to a particular Bds\+Server running on a particular host using the connect\+Service(in String) function. Once connected you need to login to the Bds\+Server as a particular user using the connect(in String user, in String password). After your have successfully logged in you can use the various objects methods. These result in a remote procedure call (RPC) to the Bds\+Server which Will imlement the function and return any data and normally an errors status (\textbf{ BError}). 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classBds_1_1AdminAccess_a2e8ff1302a9b66e7ea54aa2be744b006}\label{classBds_1_1AdminAccess_a2e8ff1302a9b66e7ea54aa2be744b006} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!AdminAccess@{AdminAccess}}
\index{AdminAccess@{AdminAccess}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{AdminAccess()}{AdminAccess()}}
{\footnotesize\ttfamily Bds\+::\+Admin\+Access\+::\+Admin\+Access (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{name = {\ttfamily \"{}\"{}} }\end{DoxyParamCaption})}



BDS RPC access class. 


\begin{DoxyParams}{Parameters}
{\em name} & The URL of the remote BOAP object name to connect to.\\
\hline
\end{DoxyParams}
This object constructor takes the name of the remote object to connect to. However this is normally passed as \"{}\"{} as the \textbf{ connect\+Service()} function is normally used to perform the actual remote connection. 

\doxysubsection{Member Function Documentation}
\Hypertarget{classBds_1_1AdminAccess_ad8a3176f5194d9b048525fca0a71b237}\label{classBds_1_1AdminAccess_ad8a3176f5194d9b048525fca0a71b237} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!connect@{connect}}
\index{connect@{connect}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{connect()}{connect()}}
{\footnotesize\ttfamily Admin\+Access\+::connect (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{user,  }\item[{\textbf{ BString}}]{password }\end{DoxyParamCaption})}



Provides user/password information. 

Python\+: (\textbf{ BError} err) = connect(\+Python\+Str user, Python\+Str password); \Hypertarget{classBds_1_1AdminAccess_a02c1e5822c26f245f2575c155d31a46e}\label{classBds_1_1AdminAccess_a02c1e5822c26f245f2575c155d31a46e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!validateUser@{validateUser}}
\index{validateUser@{validateUser}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{validateUser()}{validateUser()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::validate\+User (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{user,  }\item[{\textbf{ BString}}]{email }\end{DoxyParamCaption})}



Checks the user given name or email. 

Python\+: (\textbf{ BError} err) = validate\+User(\+Python\+Str user, Python\+Str email);


\begin{DoxyParams}{Parameters}
{\em user} & The user\textquotesingle{}s name \\
\hline
{\em email} & The users email address\\
\hline
\end{DoxyParams}
Checks to see if the user as named exsists or if just the email address is provided, if any user with that email address exists. \Hypertarget{classBds_1_1AdminAccess_a8b668196050941c8c37a9917c9267886}\label{classBds_1_1AdminAccess_a8b668196050941c8c37a9917c9267886} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!setUser@{setUser}}
\index{setUser@{setUser}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{setUser()}{setUser()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::set\+User (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{user,  }\item[{\textbf{ BString}}]{email }\end{DoxyParamCaption})}



Sets user to given name or email. 

Python\+: (\textbf{ BError} err) = set\+User(\+Python\+Str user, Python\+Str email);


\begin{DoxyParams}{Parameters}
{\em user} & The user\textquotesingle{}s name \\
\hline
{\em email} & The users email address\\
\hline
\end{DoxyParams}
Changes the connection to be logged in as the given user by their user name or email address. This function will only be allowed if the current user is in the user\+Set group. The bds\+Autodrm user normally has this set so it can change the Bds\+Server\textquotesingle{}s connection to be that of the Bds\+Autodrm user for example. \Hypertarget{classBds_1_1AdminAccess_a500868d92d1dec842d2e53fbd6eb5b3f}\label{classBds_1_1AdminAccess_a500868d92d1dec842d2e53fbd6eb5b3f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!setUserReal@{setUserReal}}
\index{setUserReal@{setUserReal}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{setUserReal()}{setUserReal()}}
{\footnotesize\ttfamily Admin\+Access\+::set\+User\+Real (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Sets user back to real user. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a500868d92d1dec842d2e53fbd6eb5b3f}{set\+User\+Real()}; \Hypertarget{classBds_1_1AdminAccess_af7bbf6fe32d8d0964af927724bc16b69}\label{classBds_1_1AdminAccess_af7bbf6fe32d8d0964af927724bc16b69} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!getVersion@{getVersion}}
\index{getVersion@{getVersion}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{getVersion()}{getVersion()}}
{\footnotesize\ttfamily Admin\+Access\+::get\+Version (\begin{DoxyParamCaption}\item[{\textbf{ BString} \&}]{version,  }\item[{\textbf{ BString} \&}]{name }\end{DoxyParamCaption})}



Gets the software version and server name. 

Python\+: (\textbf{ BError} err, Python\+Str version, Python\+Str name) = \doxylink{classBds_1_1AdminAccess_af7bbf6fe32d8d0964af927724bc16b69}{get\+Version()}; \Hypertarget{classBds_1_1AdminAccess_a7d3612e5a7aa5e2730e7889e63599e7e}\label{classBds_1_1AdminAccess_a7d3612e5a7aa5e2730e7889e63599e7e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userGetList@{userGetList}}
\index{userGetList@{userGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userGetList()}{userGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::user\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1User}{User}} $>$ \&}]{users }\end{DoxyParamCaption})}



Get list of Users. 

Python\+: (\textbf{ BError} err, BList$<$\+User $>$ users) = \doxylink{classBds_1_1AdminAccess_a7d3612e5a7aa5e2730e7889e63599e7e}{user\+Get\+List()};


\begin{DoxyParams}{Parameters}
{\em users} & The returned list of all users\\
\hline
\end{DoxyParams}
This returns the complete list of users on the system \Hypertarget{classBds_1_1AdminAccess_a573fbc14a1859648daef40714eddd79e}\label{classBds_1_1AdminAccess_a573fbc14a1859648daef40714eddd79e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userUpdate@{userUpdate}}
\index{userUpdate@{userUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userUpdate()}{userUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1User}{User}}}]{user,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Update or append a user entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = user\+Update(\+BInt32 append, User user); \Hypertarget{classBds_1_1AdminAccess_a3fbd7ebc384f87949096ae4944377d58}\label{classBds_1_1AdminAccess_a3fbd7ebc384f87949096ae4944377d58} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userDelete@{userDelete}}
\index{userDelete@{userDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userDelete()}{userDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a user entry. 

Python\+: (\textbf{ BError} err) = user\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a8c1511c9fb9b3c33eac7b4e39177825e}\label{classBds_1_1AdminAccess_a8c1511c9fb9b3c33eac7b4e39177825e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userGetFromId@{userGetFromId}}
\index{userGetFromId@{userGetFromId}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userGetFromId()}{userGetFromId()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Get\+From\+Id (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\mbox{\hyperlink{classBds_1_1User}{User}} \&}]{user }\end{DoxyParamCaption})}



Get user info given user ID. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1User}{User} user) = user\+Get\+From\+Id(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_afd83b2fc68d76ff1a1f93dbd44513e78}\label{classBds_1_1AdminAccess_afd83b2fc68d76ff1a1f93dbd44513e78} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userGet@{userGet}}
\index{userGet@{userGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userGet()}{userGet()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Get (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1User}{User}} \&}]{user }\end{DoxyParamCaption})}



Get user info of the currently loogged in user. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1User}{User} user) = \doxylink{classBds_1_1AdminAccess_afd83b2fc68d76ff1a1f93dbd44513e78}{user\+Get()}; \Hypertarget{classBds_1_1AdminAccess_ac7b272a92ccaa8ac47d07f738856a10f}\label{classBds_1_1AdminAccess_ac7b272a92ccaa8ac47d07f738856a10f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userSet@{userSet}}
\index{userSet@{userSet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userSet()}{userSet()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1User}{User}}}]{user }\end{DoxyParamCaption})}



Set user info of the currently loogged in user. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_ac7b272a92ccaa8ac47d07f738856a10f}{user\+Set(\+User user)}; \Hypertarget{classBds_1_1AdminAccess_a9c228f9908e0229c8ac02e06b8c7f743}\label{classBds_1_1AdminAccess_a9c228f9908e0229c8ac02e06b8c7f743} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userGetGroups@{userGetGroups}}
\index{userGetGroups@{userGetGroups}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userGetGroups()}{userGetGroups()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Get\+Groups (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \textbf{ BString} $>$ \&}]{groups }\end{DoxyParamCaption})}



Get list of groups the user belongs to. 

Python\+: (\textbf{ BError} err, \textbf{ BList$<$\+BString $>$} groups) = \doxylink{classBds_1_1AdminAccess_a9c228f9908e0229c8ac02e06b8c7f743}{user\+Get\+Groups()}; \Hypertarget{classBds_1_1AdminAccess_a437a9f4b46b894c775e516628cfff211}\label{classBds_1_1AdminAccess_a437a9f4b46b894c775e516628cfff211} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userGetOptions@{userGetOptions}}
\index{userGetOptions@{userGetOptions}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userGetOptions()}{userGetOptions()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Get\+Options (\begin{DoxyParamCaption}\item[{\textbf{ BDict}$<$ \textbf{ BString} $>$ \&}]{items }\end{DoxyParamCaption})}



Get users options. 

Python\+: (\textbf{ BError} err, \textbf{ BDict$<$\+BString $>$} items) = \doxylink{classBds_1_1AdminAccess_a437a9f4b46b894c775e516628cfff211}{user\+Get\+Options()}; \Hypertarget{classBds_1_1AdminAccess_a420974a01627655b0ae38a3adb9b7898}\label{classBds_1_1AdminAccess_a420974a01627655b0ae38a3adb9b7898} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!userSetOptions@{userSetOptions}}
\index{userSetOptions@{userSetOptions}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{userSetOptions()}{userSetOptions()}}
{\footnotesize\ttfamily Admin\+Access\+::user\+Set\+Options (\begin{DoxyParamCaption}\item[{\textbf{ BDict}$<$ \textbf{ BString} $>$ \&}]{items }\end{DoxyParamCaption})}



Set users options. 

Python\+: (\textbf{ BError} err, \textbf{ BDict$<$\+BString $>$} items) = \doxylink{classBds_1_1AdminAccess_a420974a01627655b0ae38a3adb9b7898}{user\+Set\+Options()}; \Hypertarget{classBds_1_1AdminAccess_a379feb7d9423a834f005009236fe2862}\label{classBds_1_1AdminAccess_a379feb7d9423a834f005009236fe2862} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!groupGetList@{groupGetList}}
\index{groupGetList@{groupGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{groupGetList()}{groupGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::group\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Group}{Group}} $>$ \&}]{groups }\end{DoxyParamCaption})}



Get list of Groups. 

Python\+: (\textbf{ BError} err, BList$<$\+Group $>$ groups) = \doxylink{classBds_1_1AdminAccess_a379feb7d9423a834f005009236fe2862}{group\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_a6f3a74eda3d4f98aaf5ae54d7b626906}\label{classBds_1_1AdminAccess_a6f3a74eda3d4f98aaf5ae54d7b626906} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!groupUpdate@{groupUpdate}}
\index{groupUpdate@{groupUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{groupUpdate()}{groupUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::group\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Group}{Group}}}]{group,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Update or append a group entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = group\+Update(\+BInt32 append, Group group); \Hypertarget{classBds_1_1AdminAccess_a8c19cab7376ed783a4b937ae013fc3b6}\label{classBds_1_1AdminAccess_a8c19cab7376ed783a4b937ae013fc3b6} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!groupDelete@{groupDelete}}
\index{groupDelete@{groupDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{groupDelete()}{groupDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::group\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a group entry. 

Python\+: (\textbf{ BError} err) = group\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a0f2c4892f6a6d2088cec044c85a9a0b8}\label{classBds_1_1AdminAccess_a0f2c4892f6a6d2088cec044c85a9a0b8} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!accessGroupGetList@{accessGroupGetList}}
\index{accessGroupGetList@{accessGroupGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{accessGroupGetList()}{accessGroupGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::access\+Group\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1AccessGroup}{Access\+Group}} $>$ \&}]{access\+Groups }\end{DoxyParamCaption})}



Get list of Access\+Groups. 

Python\+: (\textbf{ BError} err, BList$<$\+Access\+Group $>$ access\+Groups) = \doxylink{classBds_1_1AdminAccess_a0f2c4892f6a6d2088cec044c85a9a0b8}{access\+Group\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_a89f9efe4b645b41af2a3403d0011da55}\label{classBds_1_1AdminAccess_a89f9efe4b645b41af2a3403d0011da55} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!accessGroupUpdate@{accessGroupUpdate}}
\index{accessGroupUpdate@{accessGroupUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{accessGroupUpdate()}{accessGroupUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::access\+Group\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1AccessGroup}{Access\+Group}}}]{group,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Update or append an \doxylink{classBds_1_1AccessGroup}{Access\+Group} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = access\+Group\+Update(\+BInt32 append, Access\+Group group); \Hypertarget{classBds_1_1AdminAccess_a5b7eb357ce645c4fcdf4363d17b01ec3}\label{classBds_1_1AdminAccess_a5b7eb357ce645c4fcdf4363d17b01ec3} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!accessGroupDelete@{accessGroupDelete}}
\index{accessGroupDelete@{accessGroupDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{accessGroupDelete()}{accessGroupDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::access\+Group\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete an \doxylink{classBds_1_1AccessGroup}{Access\+Group} entry. 

Python\+: (\textbf{ BError} err) = access\+Group\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_afcc1318b4452af19a6789ab59d2105bc}\label{classBds_1_1AdminAccess_afcc1318b4452af19a6789ab59d2105bc} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!getSelectionInfo@{getSelectionInfo}}
\index{getSelectionInfo@{getSelectionInfo}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{getSelectionInfo()}{getSelectionInfo()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::get\+Selection\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespaceBds_abde7774a9183d612e43055b51841928b}{Selection\+Group}}}]{group,  }\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{selection\+In,  }\item[{\mbox{\hyperlink{classBds_1_1SelectionInfo}{Selection\+Info}} \&}]{selection\+Info }\end{DoxyParamCaption})}



Get information on possible selections. Use in GUI programs to list options available. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1SelectionInfo}{Selection\+Info} selection\+Info) = get\+Selection\+Info(\+Selection\+Group group, Selection selection\+In);


\begin{DoxyParams}{Parameters}
{\em group} & The type of selection info requested. Can be Selection\+Group\+Data to get selections for \doxylink{classBds_1_1Sensor}{Sensor} data, Selection\+Group\+Meta\+Data for Metadata selectrions and Selection\+Group\+Data\+With\+Count as for Selection\+Group\+Data but alos returns the total number of Data\+Channels. \\
\hline
{\em selection\+In} & The current selection \\
\hline
{\em selection\+Info} & The returned selection information\\
\hline
\end{DoxyParams}
Used for selection systems such as that within a Gui to restrict the options available given partial selection parameters. Given a basic \doxylink{classBds_1_1Selection}{Selection} returns all of the \doxylink{classBds_1_1Selection}{Selection} options available based on the \doxylink{classBds_1_1Sensor}{Sensor} data or Metadata in the BDS. For example if the selection\+In defines one particular \doxylink{classBds_1_1Network}{Network} and one particular \doxylink{classBds_1_1Station}{Station}, the get\+Selection\+Info function will return a list of Channels and Sources for that base selection. \Hypertarget{classBds_1_1AdminAccess_a0e925c6d680b336c0e78505c200f06e6}\label{classBds_1_1AdminAccess_a0e925c6d680b336c0e78505c200f06e6} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!getSelections@{getSelections}}
\index{getSelections@{getSelections}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{getSelections()}{getSelections()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::get\+Selections (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespaceBds_abde7774a9183d612e43055b51841928b}{Selection\+Group}}}]{group,  }\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{selection\+In,  }\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}} \&}]{selection\+Out }\end{DoxyParamCaption})}



Get selection list. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1Selection}{Selection} selection\+Out) = get\+Selections(\+Selection\+Group group, Selection selection\+In);


\begin{DoxyParams}{Parameters}
{\em group} & The type of selection info requested. Currently ignored. \\
\hline
{\em selection\+In} & The selection which may include regular expressions and \doxylink{classBds_1_1Station}{Station} arrays. \\
\hline
{\em selection\+Out} & The full \doxylink{classBds_1_1Sensor}{Sensor} data selection after regular expressions have been expanded and any Array\textquotesingle{}s exapanded into a list of Stations.\\
\hline
\end{DoxyParams}
This is used to expand a \doxylink{classBds_1_1Sensor}{Sensor} data \doxylink{classBds_1_1Selection}{Selection} to a full \doxylink{classBds_1_1Selection}{Selection} list. \Hypertarget{classBds_1_1AdminAccess_a936ba1aa568292b2f1eaefa2e8380076}\label{classBds_1_1AdminAccess_a936ba1aa568292b2f1eaefa2e8380076} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!networkGetList@{networkGetList}}
\index{networkGetList@{networkGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{networkGetList()}{networkGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::network\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Network}{Network}} $>$ \&}]{networks }\end{DoxyParamCaption})}



Get list of Networks. 

Python\+: (\textbf{ BError} err, BList$<$\+Network $>$ networks) = \doxylink{classBds_1_1AdminAccess_a936ba1aa568292b2f1eaefa2e8380076}{network\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_ad04bfae9787facff173aaa9efd02afd8}\label{classBds_1_1AdminAccess_ad04bfae9787facff173aaa9efd02afd8} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!networkUpdate@{networkUpdate}}
\index{networkUpdate@{networkUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{networkUpdate()}{networkUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::network\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Network}{Network}}}]{network,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Network}{Network} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = network\+Update(\+BInt32 append, Network network); \Hypertarget{classBds_1_1AdminAccess_abb6c06122a9e054c38c62917587da52e}\label{classBds_1_1AdminAccess_abb6c06122a9e054c38c62917587da52e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!networkDelete@{networkDelete}}
\index{networkDelete@{networkDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{networkDelete()}{networkDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::network\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Network}{Network} entry. 

Python\+: (\textbf{ BError} err) = network\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a669b29096bdcf45a2b18a485d0e5838a}\label{classBds_1_1AdminAccess_a669b29096bdcf45a2b18a485d0e5838a} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!stationGetList@{stationGetList}}
\index{stationGetList@{stationGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{stationGetList()}{stationGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::station\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Station}{Station}} $>$ \&}]{stations }\end{DoxyParamCaption})}



Get list of Stations. 

Python\+: (\textbf{ BError} err, BList$<$\+Station $>$ stations) = station\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em stations} & The list of Stations matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
This uses the \doxylink{classBds_1_1Network}{Network}\+:\doxylink{classBds_1_1Station}{Station} parts of the \doxylink{classBds_1_1Selection}{Selection} object to return a list of matching Stations. \Hypertarget{classBds_1_1AdminAccess_a2bd2c40245d14534817981654eb6875f}\label{classBds_1_1AdminAccess_a2bd2c40245d14534817981654eb6875f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!stationUpdate@{stationUpdate}}
\index{stationUpdate@{stationUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{stationUpdate()}{stationUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::station\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Station}{Station}}}]{station,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Station}{Station} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = station\+Update(\+BInt32 append, Station station); \Hypertarget{classBds_1_1AdminAccess_a6cdbcceabd7e0be7569f26dce918588e}\label{classBds_1_1AdminAccess_a6cdbcceabd7e0be7569f26dce918588e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!stationDelete@{stationDelete}}
\index{stationDelete@{stationDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{stationDelete()}{stationDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::station\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Station}{Station} entry. 

Python\+: (\textbf{ BError} err) = station\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a3cbcbec0b9a7ee6751eea781d2884472}\label{classBds_1_1AdminAccess_a3cbcbec0b9a7ee6751eea781d2884472} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!locationGetList@{locationGetList}}
\index{locationGetList@{locationGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{locationGetList()}{locationGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::location\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Location}{Location}} $>$ \&}]{locations }\end{DoxyParamCaption})}



Get list of \doxylink{classBds_1_1Station}{Station}, \doxylink{classBds_1_1Channel}{Channel} or both Locations depending on the sel.\+location\+Select parameter. 

Python\+: (\textbf{ BError} err, BList$<$\+Location $>$ locations) = location\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em locations} & The list of Locations matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
This uses the \doxylink{classBds_1_1Network}{Network}\+:\doxylink{classBds_1_1Station}{Station} and optionaly the \doxylink{classBds_1_1Channel}{Channel} parts of the \doxylink{classBds_1_1Selection}{Selection} object to return a list of matching Stations. The \doxylink{classBds_1_1Selection_acdd364d854158204a8226d26c5facb0d}{Selection.\+location\+Select} parameter can be set to Location\+Select\+All, Location\+Select\+Station or Location\+Select\+Channel. If set to Location\+Select\+Station will return the locations of the Stations matched. If set to Location\+Select\+Channel will return the locations of the Channels matched. If set to Location\+Select\+All (The default) will return the locations of the Channels matched if they have Locations or otherwise that of the Stations. \Hypertarget{classBds_1_1AdminAccess_a067bb79106c6dbcee4bc0ae2adce9d0a}\label{classBds_1_1AdminAccess_a067bb79106c6dbcee4bc0ae2adce9d0a} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!locationUpdate@{locationUpdate}}
\index{locationUpdate@{locationUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{locationUpdate()}{locationUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::location\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Location}{Location}}}]{location,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Station}{Station} \doxylink{classBds_1_1Location}{Location} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = location\+Update(\+BInt32 append, Location location); \Hypertarget{classBds_1_1AdminAccess_aaa8fcb017dac79dda2c1b91800f77493}\label{classBds_1_1AdminAccess_aaa8fcb017dac79dda2c1b91800f77493} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!locationDelete@{locationDelete}}
\index{locationDelete@{locationDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{locationDelete()}{locationDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::location\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Station}{Station} \doxylink{classBds_1_1Location}{Location} entry. 

Python\+: (\textbf{ BError} err) = location\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a316f7336a520eaba284e378696201389}\label{classBds_1_1AdminAccess_a316f7336a520eaba284e378696201389} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelGetList@{channelGetList}}
\index{channelGetList@{channelGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelGetList()}{channelGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::channel\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Channel}{Channel}} $>$ \&}]{channels }\end{DoxyParamCaption})}



Get list of Channels. 

Python\+: (\textbf{ BError} err, BList$<$\+Channel $>$ channels) = channel\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em channels} & The list of Channels matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
If the selection.\+channel\+Id is set to a value other than 0, this will return a list of one \doxylink{classBds_1_1Channel}{Channel} which matches that id. Otherwise it will return a list of Channels matchin the Network\+:\+Station\+:\doxylink{classBds_1_1Channel}{Channel} regular expression fields of the selection. \Hypertarget{classBds_1_1AdminAccess_ae525aaea542a996370daebdd9fc2c39f}\label{classBds_1_1AdminAccess_ae525aaea542a996370daebdd9fc2c39f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelGet@{channelGet}}
\index{channelGet@{channelGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelGet()}{channelGet()}}
{\footnotesize\ttfamily Admin\+Access\+::channel\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\mbox{\hyperlink{classBds_1_1Channel}{Channel}} \&}]{channel }\end{DoxyParamCaption})}



Get a specific channel given its ID. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1Channel}{Channel} channel) = channel\+Get(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_aa82fd8f10089bed8917315795ef87960}\label{classBds_1_1AdminAccess_aa82fd8f10089bed8917315795ef87960} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelUpdate@{channelUpdate}}
\index{channelUpdate@{channelUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelUpdate()}{channelUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::channel\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Channel}{Channel}}}]{channel,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Channel}{Channel} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = channel\+Update(\+BInt32 append, Channel channel); \Hypertarget{classBds_1_1AdminAccess_a50dd476644bd2ab40c3dd0eb11bed0f3}\label{classBds_1_1AdminAccess_a50dd476644bd2ab40c3dd0eb11bed0f3} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelDelete@{channelDelete}}
\index{channelDelete@{channelDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelDelete()}{channelDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::channel\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Channel}{Channel} entry. 

Python\+: (\textbf{ BError} err) = channel\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_aebad66047693c0546b104f87a2f7e952}\label{classBds_1_1AdminAccess_aebad66047693c0546b104f87a2f7e952} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourceGetList@{sourceGetList}}
\index{sourceGetList@{sourceGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourceGetList()}{sourceGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Source}{Source}} $>$ \&}]{sources }\end{DoxyParamCaption})}



Get list of Sources. 

Python\+: (\textbf{ BError} err, BList$<$\+Source $>$ sources) = \doxylink{classBds_1_1AdminAccess_aebad66047693c0546b104f87a2f7e952}{source\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_a91b5dfacfc001902b163138fa21a0a03}\label{classBds_1_1AdminAccess_a91b5dfacfc001902b163138fa21a0a03} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourceUpdate@{sourceUpdate}}
\index{sourceUpdate@{sourceUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourceUpdate()}{sourceUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Source}{Source}}}]{source,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Source}{Source} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = source\+Update(\+BInt32 append, Source source); \Hypertarget{classBds_1_1AdminAccess_ac4fc262c14a77037cfea4e4228faba1c}\label{classBds_1_1AdminAccess_ac4fc262c14a77037cfea4e4228faba1c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourceDelete@{sourceDelete}}
\index{sourceDelete@{sourceDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourceDelete()}{sourceDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Source}{Source} entry. 

Python\+: (\textbf{ BError} err) = source\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a391c07fd9718efc7952b941ae5731871}\label{classBds_1_1AdminAccess_a391c07fd9718efc7952b941ae5731871} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourcePriorityGetList@{sourcePriorityGetList}}
\index{sourcePriorityGetList@{sourcePriorityGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourcePriorityGetList()}{sourcePriorityGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Priority\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SourcePriority}{Source\+Priority}} $>$ \&}]{source\+Prioritys }\end{DoxyParamCaption})}



Get list of Source\+Priorities. 

Python\+: (\textbf{ BError} err, BList$<$\+Source\+Priority $>$ source\+Prioritys) = \doxylink{classBds_1_1AdminAccess_a391c07fd9718efc7952b941ae5731871}{source\+Priority\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_abeab3d9fe04cfba5b784c10963148bf7}\label{classBds_1_1AdminAccess_abeab3d9fe04cfba5b784c10963148bf7} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourcePriorityUpdate@{sourcePriorityUpdate}}
\index{sourcePriorityUpdate@{sourcePriorityUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourcePriorityUpdate()}{sourcePriorityUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Priority\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1SourcePriority}{Source\+Priority}}}]{source\+Priority,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}

Python\+: (\textbf{ BError} err, Python\+Int id) = source\+Priority\+Update(\+BInt32 append, Source\+Priority source\+Priority); \Hypertarget{classBds_1_1AdminAccess_a07eded6056c260eef9c3b575dfae980f}\label{classBds_1_1AdminAccess_a07eded6056c260eef9c3b575dfae980f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sourcePriorityDelete@{sourcePriorityDelete}}
\index{sourcePriorityDelete@{sourcePriorityDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sourcePriorityDelete()}{sourcePriorityDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::source\+Priority\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}

Python\+: (\textbf{ BError} err) = source\+Priority\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a2b717eba321673093d2e5c89ffebf94c}\label{classBds_1_1AdminAccess_a2b717eba321673093d2e5c89ffebf94c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelInstrumentGetList@{channelInstrumentGetList}}
\index{channelInstrumentGetList@{channelInstrumentGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelInstrumentGetList()}{channelInstrumentGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::channel\+Instrument\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1ChannelInstrument}{Channel\+Instrument}} $>$ \&}]{channel\+Instruments }\end{DoxyParamCaption})}



Get list of \doxylink{classBds_1_1Channel}{Channel} Instruments. 

Python\+: (\textbf{ BError} err, BList$<$\+Channel\+Instrument $>$ channel\+Instruments) = channel\+Instrument\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em channel\+Instruments} & The list of Channel\+Instruments matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
This uses the Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields of the \doxylink{classBds_1_1Selection}{Selection} to return a list of matching \doxylink{classBds_1_1Channel}{Channel} Instruments. \Hypertarget{classBds_1_1AdminAccess_afafcf9d6d45c8c2ef15e4a4d0f88d437}\label{classBds_1_1AdminAccess_afafcf9d6d45c8c2ef15e4a4d0f88d437} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelInstrumentUpdate@{channelInstrumentUpdate}}
\index{channelInstrumentUpdate@{channelInstrumentUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelInstrumentUpdate()}{channelInstrumentUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::channel\+Instrument\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1ChannelInstrument}{Channel\+Instrument}}}]{channel\+Instrument,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a Instrument entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = channel\+Instrument\+Update(\+BInt32 append, Channel\+Instrument channel\+Instrument); \Hypertarget{classBds_1_1AdminAccess_aea089d4fd7e012e8ff5c8cc429774726}\label{classBds_1_1AdminAccess_aea089d4fd7e012e8ff5c8cc429774726} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!channelInstrumentDelete@{channelInstrumentDelete}}
\index{channelInstrumentDelete@{channelInstrumentDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{channelInstrumentDelete()}{channelInstrumentDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::channel\+Instrument\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete an Instrument entry. 

Python\+: (\textbf{ BError} err) = channel\+Instrument\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_ab8a943d027cb5bde9542fe1bba03afca}\label{classBds_1_1AdminAccess_ab8a943d027cb5bde9542fe1bba03afca} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!digitiserGetList@{digitiserGetList}}
\index{digitiserGetList@{digitiserGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{digitiserGetList()}{digitiserGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::digitiser\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}} $>$ \&}]{digitisers }\end{DoxyParamCaption})}



Get list of Digitisers. 

Python\+: (\textbf{ BError} err, BList$<$\+Digitiser $>$ digitisers) = digitiser\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em digitisers} & The list of Digitisers matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
If selection.\+digitiser\+Id is set, then return the single matching \doxylink{classBds_1_1Digitiser}{Digitiser}. Otherwise use the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to return a list of matching Digitisers. \Hypertarget{classBds_1_1AdminAccess_ad939f1cee2294695c001500a29ffef6a}\label{classBds_1_1AdminAccess_ad939f1cee2294695c001500a29ffef6a} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!digitiserGet@{digitiserGet}}
\index{digitiserGet@{digitiserGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{digitiserGet()}{digitiserGet()}}
{\footnotesize\ttfamily Admin\+Access\+::digitiser\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}} \&}]{digitiser }\end{DoxyParamCaption})}



Get a \doxylink{classBds_1_1Digitiser}{Digitiser} object given its ID. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1Digitiser}{Digitiser} digitiser) = digitiser\+Get(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_aec00d8095f13fdd9f18b24f85fdad496}\label{classBds_1_1AdminAccess_aec00d8095f13fdd9f18b24f85fdad496} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!digitiserUpdate@{digitiserUpdate}}
\index{digitiserUpdate@{digitiserUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{digitiserUpdate()}{digitiserUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::digitiser\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Digitiser}{Digitiser}}}]{digitiser,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Digitiser}{Digitiser} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = digitiser\+Update(\+BInt32 append, Digitiser digitiser); \Hypertarget{classBds_1_1AdminAccess_a20b07112982dcb06c3b643e80139a72f}\label{classBds_1_1AdminAccess_a20b07112982dcb06c3b643e80139a72f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!digitiserDelete@{digitiserDelete}}
\index{digitiserDelete@{digitiserDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{digitiserDelete()}{digitiserDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::digitiser\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Digitiser}{Digitiser} entry. 

Python\+: (\textbf{ BError} err) = digitiser\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_aaf20f92ef7403f83896f8f515c009da0}\label{classBds_1_1AdminAccess_aaf20f92ef7403f83896f8f515c009da0} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sensorGetList@{sensorGetList}}
\index{sensorGetList@{sensorGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sensorGetList()}{sensorGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::sensor\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Sensor}{Sensor}} $>$ \&}]{sensors }\end{DoxyParamCaption})}



Get list of Sensors. 

Python\+: (\textbf{ BError} err, BList$<$\+Sensor $>$ sensors) = sensor\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em sensors} & The list of Sensors matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
If selection.\+sensor\+Id is set, then return the single matching \doxylink{classBds_1_1Sensor}{Sensor}. Otherwise use the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to return a list of matching Sensors. \Hypertarget{classBds_1_1AdminAccess_ae84e3943a4ead17cbbe4b3cb068749d2}\label{classBds_1_1AdminAccess_ae84e3943a4ead17cbbe4b3cb068749d2} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sensorGet@{sensorGet}}
\index{sensorGet@{sensorGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sensorGet()}{sensorGet()}}
{\footnotesize\ttfamily Admin\+Access\+::sensor\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\mbox{\hyperlink{classBds_1_1Sensor}{Sensor}} \&}]{sensor }\end{DoxyParamCaption})}



Get a \doxylink{classBds_1_1Sensor}{Sensor} object given its ID. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1Sensor}{Sensor} sensor) = sensor\+Get(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a645b0774712d33f6c37d96b229b00066}\label{classBds_1_1AdminAccess_a645b0774712d33f6c37d96b229b00066} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sensorUpdate@{sensorUpdate}}
\index{sensorUpdate@{sensorUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sensorUpdate()}{sensorUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::sensor\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Sensor}{Sensor}}}]{sensor,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Sensor}{Sensor} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = sensor\+Update(\+BInt32 append, Sensor sensor); \Hypertarget{classBds_1_1AdminAccess_a6a19702a348da61c3fc8f2291581057b}\label{classBds_1_1AdminAccess_a6a19702a348da61c3fc8f2291581057b} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sensorDelete@{sensorDelete}}
\index{sensorDelete@{sensorDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sensorDelete()}{sensorDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::sensor\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Sensor}{Sensor} entry. 

Python\+: (\textbf{ BError} err) = sensor\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a0c050b7a6d37afa2d19ba0f85b37199c}\label{classBds_1_1AdminAccess_a0c050b7a6d37afa2d19ba0f85b37199c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!calibrationGetList@{calibrationGetList}}
\index{calibrationGetList@{calibrationGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{calibrationGetList()}{calibrationGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::calibration\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Calibration}{Calibration}} $>$ \&}]{calibrations }\end{DoxyParamCaption})}



Get list of Calibrations. 

Python\+: (\textbf{ BError} err, BList$<$\+Calibration $>$ calibrations) = calibration\+Get\+List(\+Selection sel); \Hypertarget{classBds_1_1AdminAccess_a0e696b22ec309cbd934841175b94dfc5}\label{classBds_1_1AdminAccess_a0e696b22ec309cbd934841175b94dfc5} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!calibrationUpdate@{calibrationUpdate}}
\index{calibrationUpdate@{calibrationUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{calibrationUpdate()}{calibrationUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::calibration\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Calibration}{Calibration}}}]{calibration,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Calibration}{Calibration} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = calibration\+Update(\+BInt32 append, Calibration calibration); \Hypertarget{classBds_1_1AdminAccess_a39f2696f425d1ec481aa1f443141bbfd}\label{classBds_1_1AdminAccess_a39f2696f425d1ec481aa1f443141bbfd} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!calibrationDelete@{calibrationDelete}}
\index{calibrationDelete@{calibrationDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{calibrationDelete()}{calibrationDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::calibration\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Calibration}{Calibration} entry. 

Python\+: (\textbf{ BError} err) = calibration\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a6a2ef1ae1e7ed0f9370b15da0e6bd8dd}\label{classBds_1_1AdminAccess_a6a2ef1ae1e7ed0f9370b15da0e6bd8dd} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!responseGetList@{responseGetList}}
\index{responseGetList@{responseGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{responseGetList()}{responseGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::response\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Response}{Response}} $>$ \&}]{responses }\end{DoxyParamCaption})}



Get list of Responses. 

Python\+: (\textbf{ BError} err, BList$<$\+Response $>$ responses) = response\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em responses} & The list of Responses matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
Use the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to return a list of matching Responses. \Hypertarget{classBds_1_1AdminAccess_ae86eb50abc4e338e9e4dbcec9bf5a657}\label{classBds_1_1AdminAccess_ae86eb50abc4e338e9e4dbcec9bf5a657} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!responseUpdate@{responseUpdate}}
\index{responseUpdate@{responseUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{responseUpdate()}{responseUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::response\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Response}{Response}}}]{response,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Response}{Response} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = response\+Update(\+BInt32 append, Response response); \Hypertarget{classBds_1_1AdminAccess_a47a92a9dc165c2adaf99bb96e6c557ee}\label{classBds_1_1AdminAccess_a47a92a9dc165c2adaf99bb96e6c557ee} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!responseDelete@{responseDelete}}
\index{responseDelete@{responseDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{responseDelete()}{responseDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::response\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Response}{Response} entry. 

Python\+: (\textbf{ BError} err) = response\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a5ed219172e5ab0e05cad80f260a13208}\label{classBds_1_1AdminAccess_a5ed219172e5ab0e05cad80f260a13208} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!eventGetList@{eventGetList}}
\index{eventGetList@{eventGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{eventGetList()}{eventGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::event\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Event}{Event}} $>$ \&}]{events }\end{DoxyParamCaption})}



Get list of Events. 

Python\+: (\textbf{ BError} err, BList$<$\+Event $>$ events) = event\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em events} & The list of Events matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
If sel.\+id or sel.\+event\+Id is set then return the \doxylink{classBds_1_1Event}{Event} with this ID. Otherwise if sel.\+name is set return an \doxylink{classBds_1_1Event}{Event} with a title matching this regular expression between sel.\+start\+Time and sel.\+end\+Time.. Otherwise match any events between sel.\+start\+Time and sel.\+end\+Time. \Hypertarget{classBds_1_1AdminAccess_ab37982f588960922eff13f6fc27b4a06}\label{classBds_1_1AdminAccess_ab37982f588960922eff13f6fc27b4a06} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!eventUpdate@{eventUpdate}}
\index{eventUpdate@{eventUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{eventUpdate()}{eventUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::event\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Event}{Event}}}]{event,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Event}{Event} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = event\+Update(\+BInt32 append, Event event); \Hypertarget{classBds_1_1AdminAccess_a9fb7a9dae2040ac6ea24cc6fd421941f}\label{classBds_1_1AdminAccess_a9fb7a9dae2040ac6ea24cc6fd421941f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!eventDelete@{eventDelete}}
\index{eventDelete@{eventDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{eventDelete()}{eventDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::event\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Event}{Event} entry. 

Python\+: (\textbf{ BError} err) = event\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a7fe777ae76e23c82db532d27c97cd240}\label{classBds_1_1AdminAccess_a7fe777ae76e23c82db532d27c97cd240} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!specialChannelGetList@{specialChannelGetList}}
\index{specialChannelGetList@{specialChannelGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{specialChannelGetList()}{specialChannelGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::special\+Channel\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SpecialChannel}{Special\+Channel}} $>$ \&}]{special\+Channels }\end{DoxyParamCaption})}



Get list of Special Channels. 

Python\+: (\textbf{ BError} err, BList$<$\+Special\+Channel $>$ special\+Channels) = special\+Channel\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & The \doxylink{classBds_1_1Selection}{Selection} \\
\hline
{\em special\+Channels} & The list of Special\+Channels matching the \doxylink{classBds_1_1Selection}{Selection}.\\
\hline
\end{DoxyParams}
This will return a list of Special\+Channels matchin the Network\+:\+Station\+:\doxylink{classBds_1_1Channel}{Channel} regular expression fields of the selection. \Hypertarget{classBds_1_1AdminAccess_ac2181b8d16f439729ce7d2f0ff12c49c}\label{classBds_1_1AdminAccess_ac2181b8d16f439729ce7d2f0ff12c49c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!specialChannelUpdate@{specialChannelUpdate}}
\index{specialChannelUpdate@{specialChannelUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{specialChannelUpdate()}{specialChannelUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::special\+Channel\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1SpecialChannel}{Special\+Channel}}}]{special\+Channel,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1SpecialChannel}{Special\+Channel} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = special\+Channel\+Update(\+BInt32 append, Special\+Channel special\+Channel); \Hypertarget{classBds_1_1AdminAccess_abeb8a9e36852fb7da799047bb6702705}\label{classBds_1_1AdminAccess_abeb8a9e36852fb7da799047bb6702705} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!specialChannelDelete@{specialChannelDelete}}
\index{specialChannelDelete@{specialChannelDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{specialChannelDelete()}{specialChannelDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::special\+Channel\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1SpecialChannel}{Special\+Channel} entry. 

Python\+: (\textbf{ BError} err) = special\+Channel\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a000e07899d07984217b8cf46913808a8}\label{classBds_1_1AdminAccess_a000e07899d07984217b8cf46913808a8} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!metadataGetChannelInfo@{metadataGetChannelInfo}}
\index{metadataGetChannelInfo@{metadataGetChannelInfo}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{metadataGetChannelInfo()}{metadataGetChannelInfo()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::metadata\+Get\+Channel\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\mbox{\hyperlink{namespaceBds_a55a3947d34c5a2ac3e8e9292efcb432d}{Metadata\+Option}}}]{options,  }\item[{\mbox{\hyperlink{classBds_1_1ChannelInfos}{Channel\+Infos}} \&}]{channel\+Infos }\end{DoxyParamCaption})}



Return the channel Meta\+Data in structured form. Normally returns an error if incomplete metadata. If option Allow\+Incomplete is set will return partial Metadata with Error\+Warning. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1ChannelInfos}{Channel\+Infos} channel\+Infos) = metadata\+Get\+Channel\+Info(\+Selection sel, Metadata\+Option options);


\begin{DoxyParams}{Parameters}
{\em sel} & Channels selection \\
\hline
{\em channel\+Infos} & Metadata information for the channels\\
\hline
\end{DoxyParams}
This function is designed to help when exporting data from the BDS. It will attempt to gather all of the Metadata present for the Channels selected. Depending on the data\+Type of the selected Channels it will check that the expected Metadata is present and if not return an Error. For Channels of data\+Type \"{}seismic\"{} it will check that the following Metadata information exists\+: \doxylink{classBds_1_1Station}{Station}, \doxylink{classBds_1_1Channel}{Channel}, \doxylink{classBds_1_1Location}{Location}. \doxylink{classBds_1_1Calibration}{Calibration}, \doxylink{classBds_1_1Response}{Response}, \doxylink{classBds_1_1ChannelInstrument}{Channel\+Instrument}. For each of the selected Channels there will be an array of \doxylink{classBds_1_1ChannelInfo}{Channel\+Info} objects. The Bds\+Server will segment the Metadata in time periods at each point an of this Metadata is changed. This each \doxylink{classBds_1_1ChannelInfo}{Channel\+Info} object will return a set of Metadata over a time period that has no change in Metadata. When exporting data it can be time segmented to match this. \Hypertarget{classBds_1_1AdminAccess_af97c277243c8fc6d97e95d0b9eddb715}\label{classBds_1_1AdminAccess_af97c277243c8fc6d97e95d0b9eddb715} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!metadataGetFormatted@{metadataGetFormatted}}
\index{metadataGetFormatted@{metadataGetFormatted}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{metadataGetFormatted()}{metadataGetFormatted()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::metadata\+Get\+Formatted (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\mbox{\hyperlink{namespaceBds_a55a3947d34c5a2ac3e8e9292efcb432d}{Metadata\+Option}}}]{options,  }\item[{\textbf{ BString}}]{format,  }\item[{\textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&}]{data }\end{DoxyParamCaption})}



Return the channel Meta\+Data in a particular format. Normally returns an error if incomplete metadata. If option Allow\+Incomplete is set will return partial Metadata with Error\+Warning. 

Python\+: (\textbf{ BError} err, BArray$<$\+BUInt8 $>$ data) = metadata\+Get\+Formatted(\+Selection sel, Metadata\+Option options, Python\+Str format);


\begin{DoxyParams}{Parameters}
{\em sel} & Channels selection \\
\hline
{\em format} & The requested Metadata output format. This should match a format specified by any of the BDS data convertors. \\
\hline
{\em data} & The raw file data for the format given in bytes.\\
\hline
\end{DoxyParams}
This function gathers all of the Metadata for the channels matching the \doxylink{classBds_1_1Selection}{Selection} and then finds a suitable BDS data format conertor to export this Metadata in the chosen format. The resultion array of Byte data can be written to a suitable file. \Hypertarget{classBds_1_1AdminAccess_a46165d019ce7de35f676d1ec0fb0f52a}\label{classBds_1_1AdminAccess_a46165d019ce7de35f676d1ec0fb0f52a} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFileGetList@{dataFileGetList}}
\index{dataFileGetList@{dataFileGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFileGetList()}{dataFileGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+File\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataFileInfo}{Data\+File\+Info}} $>$ \&}]{data\+File }\end{DoxyParamCaption})}



Get list of Data\+Files. 

Python\+: (\textbf{ BError} err, BList$<$\+Data\+File\+Info $>$ data\+File) = data\+File\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & Channels selection \\
\hline
{\em data\+Files} & The returned Data\+Files\\
\hline
\end{DoxyParams}
If sel.\+id is set, then returns the single \doxylink{classBds_1_1DataFile}{Data\+File} matching this id. Otherwise uses the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to select a list of Data\+Files. \Hypertarget{classBds_1_1AdminAccess_aa05963bbcac3c79634434899e95f9e10}\label{classBds_1_1AdminAccess_aa05963bbcac3c79634434899e95f9e10} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFileUpdate@{dataFileUpdate}}
\index{dataFileUpdate@{dataFileUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFileUpdate()}{dataFileUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+File\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1DataFileInfo}{Data\+File\+Info}}}]{data\+File,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1DataFile}{Data\+File} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = data\+File\+Update(\+BInt32 append, Data\+File\+Info data\+File); \Hypertarget{classBds_1_1AdminAccess_a9149d47b0d0531bcf963f11af74a6b81}\label{classBds_1_1AdminAccess_a9149d47b0d0531bcf963f11af74a6b81} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFileDelete@{dataFileDelete}}
\index{dataFileDelete@{dataFileDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFileDelete()}{dataFileDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+File\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1DataFile}{Data\+File} entry. 

Python\+: (\textbf{ BError} err) = data\+File\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a977aef8899022acc98746553b0a9a430}\label{classBds_1_1AdminAccess_a977aef8899022acc98746553b0a9a430} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataChannelGetList@{dataChannelGetList}}
\index{dataChannelGetList@{dataChannelGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataChannelGetList()}{dataChannelGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Channel\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataChannel}{Data\+Channel}} $>$ \&}]{data\+Channel }\end{DoxyParamCaption})}



Get list of Data\+Channels. 

Python\+: (\textbf{ BError} err, BList$<$\+Data\+Channel $>$ data\+Channel) = data\+Channel\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & Channels selection \\
\hline
{\em data\+Channels} & The returned \doxylink{classBds_1_1DataChannel}{Data\+Channel}\\
\hline
\end{DoxyParams}
Uses the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to select a list of Data\+Channels. \Hypertarget{classBds_1_1AdminAccess_a40c1eaa06941f611f067f89082bc4e48}\label{classBds_1_1AdminAccess_a40c1eaa06941f611f067f89082bc4e48} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataChannelUpdate@{dataChannelUpdate}}
\index{dataChannelUpdate@{dataChannelUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataChannelUpdate()}{dataChannelUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Channel\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1DataChannel}{Data\+Channel}}}]{data\+Channel,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1DataChannel}{Data\+Channel} entry. 

Python\+: (\textbf{ BError} err, Python\+Int id) = data\+Channel\+Update(\+BInt32 append, Data\+Channel data\+Channel); \Hypertarget{classBds_1_1AdminAccess_a6899caaa4f43ef3ac09f136d19961e6b}\label{classBds_1_1AdminAccess_a6899caaa4f43ef3ac09f136d19961e6b} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataChannelDelete@{dataChannelDelete}}
\index{dataChannelDelete@{dataChannelDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataChannelDelete()}{dataChannelDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Channel\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1DataChannel}{Data\+Channel} entry. 

Python\+: (\textbf{ BError} err) = data\+Channel\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a8117c6038a5ad43c2f2157171795ed1f}\label{classBds_1_1AdminAccess_a8117c6038a5ad43c2f2157171795ed1f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataAvailability@{dataAvailability}}
\index{dataAvailability@{dataAvailability}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataAvailability()}{dataAvailability()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Availability (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{selection,  }\item[{\textbf{ BUInt32}}]{num,  }\item[{\textbf{ BArray}$<$ \mbox{\hyperlink{classBds_1_1DataAvailChan}{Data\+Avail\+Chan}} $>$ \&}]{data\+Avail\+Chans }\end{DoxyParamCaption})}



Return availability for data matching the given selection parameters. If num \texorpdfstring{$>$}{>} 0 segment ito this number of fixed time segments. 

Python\+: (\textbf{ BError} err, BArray$<$\+Data\+Avail\+Chan $>$ data\+Avail\+Chans) = data\+Availability(\+Selection selection, Python\+Int num);


\begin{DoxyParams}{Parameters}
{\em sel} & The selection information \\
\hline
{\em num} & The number of availability time segments to return. \\
\hline
{\em data\+Avail\+Chans} & Information on the availablility of sensor data for the selected channel\\
\hline
\end{DoxyParams}
This function will return a list of \doxylink{classBds_1_1Sensor}{Sensor} data availability information for the selected Channels. If num \texorpdfstring{$>$}{>} 0 then it will restrict the number of time segments to that number. The time segments will be linearly spaced in time. If num ==0 then the system will return a data availabliliy segment for each \doxylink{classBds_1_1DataChannel}{Data\+Channel} continuous segment. This can be slow and return a very large number of segments. \Hypertarget{classBds_1_1AdminAccess_ac405aa58aecc7606513db8fb9fbc658a}\label{classBds_1_1AdminAccess_ac405aa58aecc7606513db8fb9fbc658a} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataSearch@{dataSearch}}
\index{dataSearch@{dataSearch}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataSearch()}{dataSearch()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Search (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{selection,  }\item[{\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} \&}]{data\+Info }\end{DoxyParamCaption})}



Search for data matching the given selection parameters. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1DataInfo}{Data\+Info} data\+Info) = data\+Search(\+Selection selection);


\begin{DoxyParams}{Parameters}
{\em selection} & \doxylink{classBds_1_1Channel}{Channel} \doxylink{classBds_1_1Selection}{Selection} information \\
\hline
{\em data\+Info} & \doxylink{classBds_1_1Sensor}{Sensor} data selection information with data segmented by actual data file segments with extra information if available\\
\hline
\end{DoxyParams}
This will perform a search for \doxylink{classBds_1_1Sensor}{Sensor} data matching the \doxylink{classBds_1_1Selection}{Selection}. Be careful with the selction as their could be a lot of data matching that will then hit resource limits. There are restrictions on the maximum time range allowed (Max\+Time\+Period) and the maximum \doxylink{classBds_1_1DataChannel}{Data\+Channel} segments returned (Max\+Num\+Channels). The return \doxylink{classBds_1_1DataInfo}{Data\+Info} object can be interidated for information on the data, such as sample\+Rates and/or used in the \doxylink{classBds_1_1AdminAccess_a6d8b3a8edaea4a40a21d33fb0f61b73d}{data\+Open()} function for actual access to the \doxylink{classBds_1_1Sensor}{Sensor} data. \Hypertarget{classBds_1_1AdminAccess_aa2173246bd8b5a326e9e2df9c51af451}\label{classBds_1_1AdminAccess_aa2173246bd8b5a326e9e2df9c51af451} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataGetChannelInfo@{dataGetChannelInfo}}
\index{dataGetChannelInfo@{dataGetChannelInfo}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataGetChannelInfo()}{dataGetChannelInfo()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Get\+Channel\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}}}]{data\+Info,  }\item[{\mbox{\hyperlink{classBds_1_1ChannelInfos}{Channel\+Infos}} \&}]{channel\+Infos }\end{DoxyParamCaption})}



Return the channel Meta\+Data in structured form. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1ChannelInfos}{Channel\+Infos} channel\+Infos) = data\+Get\+Channel\+Info(\+Data\+Info data\+Info);


\begin{DoxyParams}{Parameters}
{\em data\+Info} & Data selection \\
\hline
{\em channel\+Infos} & Metadata information for the channels\\
\hline
\end{DoxyParams}
This function returns all of the Metadata for the given Channels specified in the data\+Info selection. It uses the \doxylink{classBds_1_1AdminAccess_a000e07899d07984217b8cf46913808a8}{metadata\+Get\+Channel\+Info()} function converting the \doxylink{classBds_1_1DataInfo}{Data\+Info} selection to a more general \doxylink{classBds_1_1Selection}{Selection} first. \Hypertarget{classBds_1_1AdminAccess_a6d8b3a8edaea4a40a21d33fb0f61b73d}\label{classBds_1_1AdminAccess_a6d8b3a8edaea4a40a21d33fb0f61b73d} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataOpen@{dataOpen}}
\index{dataOpen@{dataOpen}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataOpen()}{dataOpen()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Open (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}}}]{data\+Info,  }\item[{\textbf{ BString}}]{mode,  }\item[{\textbf{ BString}}]{format,  }\item[{\textbf{ BUInt32}}]{flags,  }\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}} \&}]{data\+Handle }\end{DoxyParamCaption})}



Open a data file. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em data\+Info} & The sensor data to open selection \\
\hline
\mbox{\texttt{ in}}  & {\em mode} & The open format. The mode should be set to \"{}w\"{} for writing data, \"{}a\"{} when appending data and \"{}r\"{} for reading data. \\
\hline
\mbox{\texttt{ in}}  & {\em 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. \\
\hline
\mbox{\texttt{ in}}  & {\em flags} & A bitset of flags as defined by \doxylink{namespaceBds_acc1f811634e9207803e677ee705669c2}{Bds\+::\+Data\+Flags}. \\
\hline
\mbox{\texttt{ out}}  & {\em data\+Handle} & The handle for the open data set\\
\hline
\end{DoxyParams}
Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1DataHandle}{Data\+Handle} data\+Handle) = data\+Open(\+Data\+Info data\+Info, Python\+Str mode, Python\+Str format, Python\+Int flags);


\begin{DoxyParams}{Parameters}
{\em data\+Info} & Data selection defining the \doxylink{classBds_1_1Sensor}{Sensor} data Channels \\
\hline
{\em mode} & The open mode. This can be \"{}r\"{} for read access, \"{}w\"{} for write access and \"{}aday\"{} to append to a day file. \\
\hline
{\em format} & This is the format to use. It can be \"{}\+API-\/\+SM\"{} for multiplexed by sample or \"{}\+API-\/\+CM\"{} for multiplexed by channel. For reads it can also be one of the BDS data convertors supported formats. \\
\hline
{\em flags} & Bit set of Data\+Flags. Can include\+: Data\+Flag\+Clip\+Data\+To\+Time, Data\+Flag\+Clip\+Data\+To\+Channels, Data\+Flag\+Merge\+Segments and Data\+Flag\+No\+Metadata \\
\hline
{\em data\+Handle} & The returned data handle to access this data set\\
\hline
\end{DoxyParams}
This function opens a set of \doxylink{classBds_1_1Sensor}{Sensor} data files in the Bds\+Server for read, write or append access. When the format is \"{}\+API-\/\+SM\"{} or \"{}\+API-\/\+CM\"{} then the raw data blocks can be accessed using the \doxylink{classBds_1_1AdminAccess_a73c88802e602cf654790b8d9e49f685f}{data\+Seek\+Block()} and \doxylink{classBds_1_1AdminAccess_a80ebc0650d5ac47b4b785741e4a250c0}{data\+Get\+Block()} functions. \doxylink{classBds_1_1Note}{Note} that the \"{}\+API-\/\+SM\"{} format requires the Channels selected to be synchonously sampled and so can only be used for certain import/export data formats where this is the case. The flags are used when reading data. Normaly whole contigous Data\+Blocks are returned. The actual starttime and endtime of the overall data may thus be before and after the selection. The Data\+Flag\+Clip\+Data\+To\+Time \"{}clips\"{} the first and last blocks, removing samples, so the time match the actual selection. The Data\+Flag\+Clip\+Data\+To\+Channels \"{}clips\"{} the blocks so that all of the Channels contain data over the selection period as some Channels otherwise could be missing data for a portion of the \doxylink{classBds_1_1Selection}{Selection}. Data\+Flag\+Merge\+Segments mergese data segments that have matching end and start times into one continuous segment. Data\+Flag\+No\+Metadata ignores Metadata when exporting data. \Hypertarget{classBds_1_1AdminAccess_a48f32ea2e58391b305e6452b0edbb87e}\label{classBds_1_1AdminAccess_a48f32ea2e58391b305e6452b0edbb87e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataGetInfo@{dataGetInfo}}
\index{dataGetInfo@{dataGetInfo}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataGetInfo()}{dataGetInfo()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Get\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BUInt32}}]{info\+Extra,  }\item[{\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}} \&}]{data\+Info }\end{DoxyParamCaption})}



Get information on the data file. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1DataInfo}{Data\+Info} data\+Info) = data\+Get\+Info(\+Data\+Handle data\+Handle, Python\+Int info\+Extra);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em info\+Extra} & A boolean flag to say to include the extra Metadata containwed within the files \\
\hline
{\em data\+Info} & The resulting fully filled out \doxylink{classBds_1_1DataInfo}{Data\+Info} describing the data.\\
\hline
\end{DoxyParams}
This functions returns fuller, more detailed, information on the \doxylink{classBds_1_1Sensor}{Sensor} data using Metadata stored within the data files themselves. The BDS data format files can store an extensive amount of Metadata from the various import formats supported. A fair amount of this Metadata is freeform and this is for general information purposes only. The returned sample\+Rate is the samplerate calculated on the actual data samples taking into account start and end times as well as actual numbers of continuous samples. The \doxylink{classBds_1_1DataInfo}{Data\+Info} returned has a set of time segmented information per \doxylink{classBds_1_1Channel}{Channel}. Each of the \doxylink{classBds_1_1DataInfo}{Data\+Info} segments defines a cotigous set of data with no time discontinuities. \Hypertarget{classBds_1_1AdminAccess_aab1cbfa7170bee06c4c00888546114fe}\label{classBds_1_1AdminAccess_aab1cbfa7170bee06c4c00888546114fe} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataGetNotes@{dataGetNotes}}
\index{dataGetNotes@{dataGetNotes}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataGetNotes()}{dataGetNotes()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Get\+Notes (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Note}{Note}} $>$ \&}]{notes }\end{DoxyParamCaption})}



Get notes on the data file. 

Python\+: (\textbf{ BError} err, BList$<$\+Note $>$ notes) = data\+Get\+Notes(\+Data\+Handle data\+Handle);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em notes} & A list of Notes on the data\\
\hline
\end{DoxyParams}
Returns a list of system and user added notes for the data from the database. \Hypertarget{classBds_1_1AdminAccess_a24e6d4e0d2f76bf027f76f977cd57569}\label{classBds_1_1AdminAccess_a24e6d4e0d2f76bf027f76f977cd57569} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataGetWarnings@{dataGetWarnings}}
\index{dataGetWarnings@{dataGetWarnings}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataGetWarnings()}{dataGetWarnings()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Get\+Warnings (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BList}$<$ \textbf{ BString} $>$ \&}]{warnings }\end{DoxyParamCaption})}



Get information on the data file. 

Python\+: (\textbf{ BError} err, \textbf{ BList$<$\+BString $>$} warnings) = data\+Get\+Warnings(\+Data\+Handle data\+Handle);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em warnings} & A list of warning strings from the datafiles\\
\hline
\end{DoxyParams}
Returns a list of warning strings contained within the data files, typically from the data file import convertors. \Hypertarget{classBds_1_1AdminAccess_a80ebc0650d5ac47b4b785741e4a250c0}\label{classBds_1_1AdminAccess_a80ebc0650d5ac47b4b785741e4a250c0} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataGetBlock@{dataGetBlock}}
\index{dataGetBlock@{dataGetBlock}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataGetBlock()}{dataGetBlock()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Get\+Block (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BUInt32}}]{channel,  }\item[{\textbf{ BUInt32}}]{segment,  }\item[{\textbf{ BUInt32}}]{block\+Number,  }\item[{\mbox{\hyperlink{classBds_1_1DataBlock}{Data\+Block}} \&}]{data }\end{DoxyParamCaption})}



Return a block of data. 

Python\+: (\textbf{ BError} err, \doxylink{classBds_1_1DataBlock}{Data\+Block} data) = data\+Get\+Block(\+Data\+Handle data\+Handle, Python\+Int channel, Python\+Int segment, Python\+Int block\+Number);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em channel} & The channel number. 0 for all channels. \\
\hline
{\em segment} & The segment number. 0 for all segments \\
\hline
{\em block\+Number} & The block number to fetch \\
\hline
{\em data\+Block} & The returned data block\\
\hline
\end{DoxyParams}
This returns the given block number from the set of opened data files. If channel is other than 0 then it will return the data for the given channel number. If the data is sample multiplexed a \doxylink{classBds_1_1Channel}{Channel} number of 0 can be given which will return a \doxylink{classBds_1_1DataBlock}{Data\+Block} with \doxylink{classBds_1_1Sensor}{Sensor} data for all of the channels. If Segment is 0 then the block number is referenced to the start of the set of files. If a particular segment number is given then the returned block number is from within that segment. \Hypertarget{classBds_1_1AdminAccess_a73c88802e602cf654790b8d9e49f685f}\label{classBds_1_1AdminAccess_a73c88802e602cf654790b8d9e49f685f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataSeekBlock@{dataSeekBlock}}
\index{dataSeekBlock@{dataSeekBlock}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataSeekBlock()}{dataSeekBlock()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Seek\+Block (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BUInt32}}]{channel,  }\item[{\textbf{ BUInt32}}]{segment,  }\item[{\textbf{ BTime\+Stamp}}]{time,  }\item[{\textbf{ BUInt32} \&}]{block\+Number }\end{DoxyParamCaption})}



Searches for a data block matching the time given. 

Python\+: (\textbf{ BError} err, Python\+Int block\+Number) = data\+Seek\+Block(\+Data\+Handle data\+Handle, Python\+Int channel, Python\+Int segment, BTime\+Stamp time);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em channel} & The channel number. 0 for all channels. \\
\hline
{\em segment} & The segment number. 0 for all segments \\
\hline
{\em time} & The time of a sample to search for \\
\hline
{\em block\+Number} & The returned block number\\
\hline
\end{DoxyParams}
This seeks for the a \doxylink{classBds_1_1DataBlock}{Data\+Block} in the set of files that contains a sample for the time provided. If channel is other than 0 then it seeks for a \doxylink{classBds_1_1DataBlock}{Data\+Block} for the given channel. If the data is sample multiplexed a \doxylink{classBds_1_1Channel}{Channel} number of 0 can be given which will return the location of a data\+Block containing all of the Channels. If Segment is 0 then the block number returned is referenced to the start of the set of files. If a particular segment number is given then the seek and the returned block number is within that segment. \Hypertarget{classBds_1_1AdminAccess_ab51a6f3a251844be8b2af02a466af746}\label{classBds_1_1AdminAccess_ab51a6f3a251844be8b2af02a466af746} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataSetInfo@{dataSetInfo}}
\index{dataSetInfo@{dataSetInfo}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataSetInfo()}{dataSetInfo()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Set\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\mbox{\hyperlink{classBds_1_1DataInfo}{Data\+Info}}}]{data\+Info }\end{DoxyParamCaption})}



Set the info when writing to a file. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_ab51a6f3a251844be8b2af02a466af746}{data\+Set\+Info(\+Data\+Handle data\+Handle, Data\+Info data\+Info)}; \Hypertarget{classBds_1_1AdminAccess_a55dab7d6b3773a1ac6e3cf1a90529b92}\label{classBds_1_1AdminAccess_a55dab7d6b3773a1ac6e3cf1a90529b92} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataPutBlock@{dataPutBlock}}
\index{dataPutBlock@{dataPutBlock}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataPutBlock()}{dataPutBlock()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Put\+Block (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\mbox{\hyperlink{classBds_1_1DataBlock}{Data\+Block}}}]{data }\end{DoxyParamCaption})}



Send a block of data. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a55dab7d6b3773a1ac6e3cf1a90529b92}{data\+Put\+Block(\+Data\+Handle data\+Handle, Data\+Block data)}; \Hypertarget{classBds_1_1AdminAccess_a1cf4a104015f196cfa9c2a886ea0ec59}\label{classBds_1_1AdminAccess_a1cf4a104015f196cfa9c2a886ea0ec59} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataClose@{dataClose}}
\index{dataClose@{dataClose}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataClose()}{dataClose()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Close (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BError}}]{error,  }\item[{\textbf{ BInt32}}]{del }\end{DoxyParamCaption})}



Close a file. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a1cf4a104015f196cfa9c2a886ea0ec59}{data\+Close(\+Data\+Handle data\+Handle, BError error, BInt32 del)}; \Hypertarget{classBds_1_1AdminAccess_afd4b0730ea5ad0b0e04c848e96d10ad7}\label{classBds_1_1AdminAccess_afd4b0730ea5ad0b0e04c848e96d10ad7} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFormattedRead@{dataFormattedRead}}
\index{dataFormattedRead@{dataFormattedRead}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFormattedRead()}{dataFormattedRead()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Formatted\+Read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BUInt32}}]{number,  }\item[{\textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&}]{data }\end{DoxyParamCaption})}



Read the raw data from the file. 

Python\+: (\textbf{ BError} err, BArray$<$\+BUInt8 $>$ data) = data\+Formatted\+Read(\+Data\+Handle data\+Handle, Python\+Int number);


\begin{DoxyParams}{Parameters}
{\em data\+Handle} & The opened data set\textquotesingle{}s handle \\
\hline
{\em number} & The maximum number of Bytes to read \\
\hline
{\em data} & The set of data bytes in the requested format\\
\hline
\end{DoxyParams}
Given a handle to a set of data files opened for read in an external data format supported by the BDS data converters, read the raw formated data bytes from the converted file. \Hypertarget{classBds_1_1AdminAccess_af0a1b37a47a34329b72b736cf56bc26e}\label{classBds_1_1AdminAccess_af0a1b37a47a34329b72b736cf56bc26e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFormattedGetLength@{dataFormattedGetLength}}
\index{dataFormattedGetLength@{dataFormattedGetLength}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFormattedGetLength()}{dataFormattedGetLength()}}
{\footnotesize\ttfamily Admin\+Access\+::data\+Formatted\+Get\+Length (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1DataHandle}{Data\+Handle}}}]{data\+Handle,  }\item[{\textbf{ BUInt64} \&}]{length }\end{DoxyParamCaption})}



Read the length of the raw formated data file. 

Python\+: (\textbf{ BError} err, Python\+Int length) = data\+Formatted\+Get\+Length(\+Data\+Handle data\+Handle); \Hypertarget{classBds_1_1AdminAccess_ac2698b7b92146194283ef739085bbc88}\label{classBds_1_1AdminAccess_ac2698b7b92146194283ef739085bbc88} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataRealtimeConfig@{dataRealtimeConfig}}
\index{dataRealtimeConfig@{dataRealtimeConfig}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataRealtimeConfig()}{dataRealtimeConfig()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Realtime\+Config (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{enable,  }\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel }\end{DoxyParamCaption})}



Configures the sending of real-\/time data blocks. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_ac2698b7b92146194283ef739085bbc88}{data\+Realtime\+Config(\+BInt32 enable, Selection sel)};


\begin{DoxyParams}{Parameters}
{\em enable} & Enable/disable the sending of a real-\/time data stream \\
\hline
{\em sel} & The selection of channels to send\\
\hline
\end{DoxyParams}
This function has yet to be implemented. It is designed to enable or disable the sening of a stream of data from the Bds\+Server to a data viewing client. \Hypertarget{classBds_1_1AdminAccess_a96d68574d5b4ba322aebf09bb6b3bdad}\label{classBds_1_1AdminAccess_a96d68574d5b4ba322aebf09bb6b3bdad} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataRealtimeGet@{dataRealtimeGet}}
\index{dataRealtimeGet@{dataRealtimeGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataRealtimeGet()}{dataRealtimeGet()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Realtime\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{num\+Blocks,  }\item[{\textbf{ BUInt32} \&}]{num\+Blocks\+Available,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataBlockChannel}{Data\+Block\+Channel}} $>$ \&}]{data\+Blocks }\end{DoxyParamCaption})}



Returns the number of data blocks available and up to num\+Blocks of these. 

Python\+: (\textbf{ BError} err, Python\+Int num\+Blocks\+Available, BList$<$\+Data\+Block\+Channel $>$ data\+Blocks) = data\+Realtime\+Get(\+Python\+Int num\+Blocks);


\begin{DoxyParams}{Parameters}
{\em num\+Blocks} & How many blocks to return at a time \\
\hline
{\em num\+Blocks\+Available} & The number of blocks available in this stream \\
\hline
{\em data\+Blocks} & A list of the Data\+Blocks\\
\hline
\end{DoxyParams}
This function has yet to be implemented. It is designed to return a set of real-\/time Data\+Blocks from the Bds\+Server to a data viewing client. \Hypertarget{classBds_1_1AdminAccess_a629063fc0e0b9c5ddd0677b4bda9c851}\label{classBds_1_1AdminAccess_a629063fc0e0b9c5ddd0677b4bda9c851} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGroupStart@{changeGroupStart}}
\index{changeGroupStart@{changeGroupStart}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGroupStart()}{changeGroupStart()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Group\+Start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1ChangeGroup}{Change\+Group}}}]{change\+Group }\end{DoxyParamCaption})}



Start a new \doxylink{classBds_1_1ChangeGroup}{Change\+Group} when making a set of changes to the BDS\textquotesingle{}s database. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a629063fc0e0b9c5ddd0677b4bda9c851}{change\+Group\+Start(\+Change\+Group change\+Group)}; \Hypertarget{classBds_1_1AdminAccess_abf50eb7764f6e2a5e6a35c15f0c63de5}\label{classBds_1_1AdminAccess_abf50eb7764f6e2a5e6a35c15f0c63de5} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGroupEnd@{changeGroupEnd}}
\index{changeGroupEnd@{changeGroupEnd}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGroupEnd()}{changeGroupEnd()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Group\+End (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



End a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_abf50eb7764f6e2a5e6a35c15f0c63de5}{change\+Group\+End()}; \Hypertarget{classBds_1_1AdminAccess_ac70566cb877ad18da55b9f0d6a11dce5}\label{classBds_1_1AdminAccess_ac70566cb877ad18da55b9f0d6a11dce5} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGroupGetList@{changeGroupGetList}}
\index{changeGroupGetList@{changeGroupGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGroupGetList()}{changeGroupGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Group\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}}}]{range,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1ChangeGroup}{Change\+Group}} $>$ \&}]{change\+Groups }\end{DoxyParamCaption})}



Return a list of Change\+Groups. 

Python\+: (\textbf{ BError} err, BList$<$\+Change\+Group $>$ change\+Groups) = change\+Group\+Get\+List(\+List\+Range range); \Hypertarget{classBds_1_1AdminAccess_a3f03baad3d0ebcff20f7021877626b2e}\label{classBds_1_1AdminAccess_a3f03baad3d0ebcff20f7021877626b2e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGroupDelete@{changeGroupDelete}}
\index{changeGroupDelete@{changeGroupDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGroupDelete()}{changeGroupDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Group\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BTime\+Stamp}}]{before\+Date,  }\item[{\textbf{ BString}}]{type,  }\item[{\textbf{ BInt32}}]{empty }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. 

Python\+: (\textbf{ BError} err) = change\+Group\+Delete(\+BTime\+Stamp before\+Date, Python\+Str type, BInt32 empty); \Hypertarget{classBds_1_1AdminAccess_a5ed9e7f88162aea5cc388a663fd4e903}\label{classBds_1_1AdminAccess_a5ed9e7f88162aea5cc388a663fd4e903} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGetListNumber@{changeGetListNumber}}
\index{changeGetListNumber@{changeGetListNumber}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGetListNumber()}{changeGetListNumber()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Get\+List\+Number (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\textbf{ BUInt32} \&}]{number }\end{DoxyParamCaption})}



Get the number of changes in a \doxylink{classBds_1_1ChangeGroup}{Change\+Group}. 

Python\+: (\textbf{ BError} err, Python\+Int number) = change\+Get\+List\+Number(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a50537967423af3565522354a52d9e89f}\label{classBds_1_1AdminAccess_a50537967423af3565522354a52d9e89f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeGetList@{changeGetList}}
\index{changeGetList@{changeGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeGetList()}{changeGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}}}]{range,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Change}{Change}} $>$ \&}]{changes }\end{DoxyParamCaption})}



Get a list of Changes. 

Python\+: (\textbf{ BError} err, BList$<$\+Change $>$ changes) = change\+Get\+List(\+Python\+Int id, List\+Range range); \Hypertarget{classBds_1_1AdminAccess_a2683118910835c852ff692a3505ce8aa}\label{classBds_1_1AdminAccess_a2683118910835c852ff692a3505ce8aa} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!changeDelete@{changeDelete}}
\index{changeDelete@{changeDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{changeDelete()}{changeDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::change\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BTime\+Stamp}}]{before\+Date,  }\item[{\textbf{ BString}}]{type }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Change}{Change}. 

Python\+: (\textbf{ BError} err) = change\+Delete(\+BTime\+Stamp before\+Date, Python\+Str type); \Hypertarget{classBds_1_1AdminAccess_a509afe69b74e77e26f6f6d9fc414144f}\label{classBds_1_1AdminAccess_a509afe69b74e77e26f6f6d9fc414144f} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noteGetList@{noteGetList}}
\index{noteGetList@{noteGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noteGetList()}{noteGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::note\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1Selection}{Selection}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Note}{Note}} $>$ \&}]{notes }\end{DoxyParamCaption})}



Get a list of Notes. 

Python\+: (\textbf{ BError} err, BList$<$\+Note $>$ notes) = note\+Get\+List(\+Selection sel);


\begin{DoxyParams}{Parameters}
{\em sel} & Channels selection \\
\hline
{\em notes} & The returned Notes\\
\hline
\end{DoxyParams}
Uses the \doxylink{classBds_1_1Selection}{Selection}\textquotesingle{}s Network\+:\+Station\+:\+Channel\+:\doxylink{classBds_1_1Source}{Source} fields to select a list of Notes. \Hypertarget{classBds_1_1AdminAccess_ac94c6e7526cca5b56c6c30e916aa9229}\label{classBds_1_1AdminAccess_ac94c6e7526cca5b56c6c30e916aa9229} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noteUpdate@{noteUpdate}}
\index{noteUpdate@{noteUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noteUpdate()}{noteUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::note\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Note}{Note}}}]{note,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or update a \doxylink{classBds_1_1Note}{Note}. 

Python\+: (\textbf{ BError} err, Python\+Int id) = note\+Update(\+BInt32 append, Note note); \Hypertarget{classBds_1_1AdminAccess_aa15bf3a7c1f29126e92d8699f63a005e}\label{classBds_1_1AdminAccess_aa15bf3a7c1f29126e92d8699f63a005e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noteDelete@{noteDelete}}
\index{noteDelete@{noteDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noteDelete()}{noteDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::note\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Note}{Note}. 

Python\+: (\textbf{ BError} err) = note\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a43cb5aefbefd586757f5c505ee866102}\label{classBds_1_1AdminAccess_a43cb5aefbefd586757f5c505ee866102} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noteWriteDocument@{noteWriteDocument}}
\index{noteWriteDocument@{noteWriteDocument}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noteWriteDocument()}{noteWriteDocument()}}
{\footnotesize\ttfamily Admin\+Access\+::note\+Write\+Document (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\textbf{ BString}}]{format,  }\item[{\textbf{ BArray}$<$ \textbf{ BUInt8} $>$}]{data }\end{DoxyParamCaption})}



Given a \doxylink{classBds_1_1Note}{Note} write a document associated with it. 

Python\+: (\textbf{ BError} err) = note\+Write\+Document(\+Python\+Int id, Python\+Str format, BArray$<$\+BUInt8 $>$ data); \Hypertarget{classBds_1_1AdminAccess_a88a9f40483edfb9bb85b4edcbafcba6c}\label{classBds_1_1AdminAccess_a88a9f40483edfb9bb85b4edcbafcba6c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noteReadDocument@{noteReadDocument}}
\index{noteReadDocument@{noteReadDocument}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noteReadDocument()}{noteReadDocument()}}
{\footnotesize\ttfamily Admin\+Access\+::note\+Read\+Document (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id,  }\item[{\textbf{ BString} \&}]{format,  }\item[{\textbf{ BArray}$<$ \textbf{ BUInt8} $>$ \&}]{data }\end{DoxyParamCaption})}



Read a document associated with a \doxylink{classBds_1_1Note}{Note}. 

Python\+: (\textbf{ BError} err, Python\+Str format, BArray$<$\+BUInt8 $>$ data) = note\+Read\+Document(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a8b2ce1e49c565088521101632d221020}\label{classBds_1_1AdminAccess_a8b2ce1e49c565088521101632d221020} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noticesAdd@{noticesAdd}}
\index{noticesAdd@{noticesAdd}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noticesAdd()}{noticesAdd()}}
{\footnotesize\ttfamily Admin\+Access\+::notices\+Add (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{notice }\end{DoxyParamCaption})}



Add a notice line. 

Python\+: (\textbf{ BError} err) = notices\+Add(\+Python\+Str notice); \Hypertarget{classBds_1_1AdminAccess_acfa08395e2025506757078204e543375}\label{classBds_1_1AdminAccess_acfa08395e2025506757078204e543375} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noticesGetList@{noticesGetList}}
\index{noticesGetList@{noticesGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noticesGetList()}{noticesGetList()}}
{\footnotesize\ttfamily Admin\+Access\+::notices\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \textbf{ BString} $>$ \&}]{notices }\end{DoxyParamCaption})}



Get notices list. 

Python\+: (\textbf{ BError} err, \textbf{ BList$<$\+BString $>$} notices) = \doxylink{classBds_1_1AdminAccess_acfa08395e2025506757078204e543375}{notices\+Get\+List()}; \Hypertarget{classBds_1_1AdminAccess_a7f7ef53239353e7c2d99e261b26a4d24}\label{classBds_1_1AdminAccess_a7f7ef53239353e7c2d99e261b26a4d24} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!noticesClear@{noticesClear}}
\index{noticesClear@{noticesClear}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{noticesClear()}{noticesClear()}}
{\footnotesize\ttfamily Admin\+Access\+::notices\+Clear (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Clear notices list. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a7f7ef53239353e7c2d99e261b26a4d24}{notices\+Clear()}; \Hypertarget{classBds_1_1AdminAccess_a1b4e471b3eb816258572175033338349}\label{classBds_1_1AdminAccess_a1b4e471b3eb816258572175033338349} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!logGetList@{logGetList}}
\index{logGetList@{logGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{logGetList()}{logGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::log\+Get\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1LogSelect}{Log\+Select}}}]{sel,  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1Log}{Log}} $>$ \&}]{logs }\end{DoxyParamCaption})}



Get list of log entries. 

Python\+: (\textbf{ BError} err, BList$<$\+Log $>$ logs) = log\+Get\+List(\+Log\+Select sel);


\begin{DoxyParams}{Parameters}
{\em sel} & \doxylink{classBds_1_1Log}{Log} selection \\
\hline
{\em logs} & The returned \doxylink{classBds_1_1Log}{Log}\\
\hline
\end{DoxyParams}
Uses the \doxylink{classBds_1_1LogSelect}{Log\+Select} to select a set of system logs and return these. \Hypertarget{classBds_1_1AdminAccess_a92f626d6a4d147463349d56195bd84d2}\label{classBds_1_1AdminAccess_a92f626d6a4d147463349d56195bd84d2} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!logUpdate@{logUpdate}}
\index{logUpdate@{logUpdate}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{logUpdate()}{logUpdate()}}
{\footnotesize\ttfamily Admin\+Access\+::log\+Update (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{append,  }\item[{\mbox{\hyperlink{classBds_1_1Log}{Log}}}]{log,  }\item[{\textbf{ BUInt32} \&}]{id }\end{DoxyParamCaption})}



Add or Update a \doxylink{classBds_1_1Log}{Log} item. 

Python\+: (\textbf{ BError} err, Python\+Int id) = log\+Update(\+BInt32 append, Log log); \Hypertarget{classBds_1_1AdminAccess_a634d0a2a4a4fe188209b838b9874ba4d}\label{classBds_1_1AdminAccess_a634d0a2a4a4fe188209b838b9874ba4d} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!logDelete@{logDelete}}
\index{logDelete@{logDelete}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{logDelete()}{logDelete()}}
{\footnotesize\ttfamily Admin\+Access\+::log\+Delete (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id }\end{DoxyParamCaption})}



Delete a \doxylink{classBds_1_1Log}{Log} item. 

Python\+: (\textbf{ BError} err) = log\+Delete(\+Python\+Int id); \Hypertarget{classBds_1_1AdminAccess_a470e7a2b523f72527f6344d508f0ba8b}\label{classBds_1_1AdminAccess_a470e7a2b523f72527f6344d508f0ba8b} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!logAppend@{logAppend}}
\index{logAppend@{logAppend}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{logAppend()}{logAppend()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::log\+Append (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{type,  }\item[{\textbf{ BUInt32}}]{priority,  }\item[{\textbf{ BString}}]{sub\+System,  }\item[{\textbf{ BString}}]{title,  }\item[{\textbf{ BString}}]{description }\end{DoxyParamCaption})}



Append a log item. 

Python\+: (\textbf{ BError} err) = log\+Append(\+Python\+Str type, Python\+Int priority, Python\+Str sub\+System, Python\+Str title, Python\+Str description);


\begin{DoxyParams}{Parameters}
{\em type} & The log entries type\+: error, warning, notice, debug or all. \\
\hline
{\em priority} & The log events priority from 0 to 5 with 5 being the highest priority \\
\hline
{\em sub\+System} & The subsystem the log entry is from \\
\hline
{\em title} & A title for the log entry \\
\hline
{\em description} & A more detailed description of the log entry\\
\hline
\end{DoxyParams}
This allows BDS xclients, perhaps data import clients, to add BDS system log entries. \Hypertarget{classBds_1_1AdminAccess_ab93d516186974931af8d997cd97ecd23}\label{classBds_1_1AdminAccess_ab93d516186974931af8d997cd97ecd23} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!statisticsGet@{statisticsGet}}
\index{statisticsGet@{statisticsGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{statisticsGet()}{statisticsGet()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::statistics\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BDict}$<$ \textbf{ BString} $>$ \&}]{info }\end{DoxyParamCaption})}



Get a list of system statistics. 

Python\+: (\textbf{ BError} err, \textbf{ BDict$<$\+BString $>$} info) = \doxylink{classBds_1_1AdminAccess_ab93d516186974931af8d997cd97ecd23}{statistics\+Get()};


\begin{DoxyParams}{Parameters}
{\em info} & A dictionary of Bds\+Server statistics\\
\hline
\end{DoxyParams}
This returns runtime statistics from the Bds\+Server \Hypertarget{classBds_1_1AdminAccess_a4bc413cbcaa10727a095fbde3b23ad90}\label{classBds_1_1AdminAccess_a4bc413cbcaa10727a095fbde3b23ad90} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!serverConfigurationGet@{serverConfigurationGet}}
\index{serverConfigurationGet@{serverConfigurationGet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{serverConfigurationGet()}{serverConfigurationGet()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::server\+Configuration\+Get (\begin{DoxyParamCaption}\item[{\textbf{ BDict}$<$ \textbf{ BString} $>$ \&}]{items }\end{DoxyParamCaption})}



Get server configuration parameters. 

Python\+: (\textbf{ BError} err, \textbf{ BDict$<$\+BString $>$} items) = \doxylink{classBds_1_1AdminAccess_a4bc413cbcaa10727a095fbde3b23ad90}{server\+Configuration\+Get()};


\begin{DoxyParams}{Parameters}
{\em info} & A dictionary of Bds\+Server configuration entries\\
\hline
\end{DoxyParams}
This returns the list of server configuration parameters. \Hypertarget{classBds_1_1AdminAccess_a25076bbd461330365cc8b2f972cc2f2c}\label{classBds_1_1AdminAccess_a25076bbd461330365cc8b2f972cc2f2c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!dataFormatGetList@{dataFormatGetList}}
\index{dataFormatGetList@{dataFormatGetList}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{dataFormatGetList()}{dataFormatGetList()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::data\+Format\+Get\+List (\begin{DoxyParamCaption}\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1DataFormat}{Data\+Format}} $>$ \&}]{formats }\end{DoxyParamCaption})}



Get list of supported data formats. 

Python\+: (\textbf{ BError} err, BList$<$\+Data\+Format $>$ formats) = \doxylink{classBds_1_1AdminAccess_a25076bbd461330365cc8b2f972cc2f2c}{data\+Format\+Get\+List()};


\begin{DoxyParams}{Parameters}
{\em formats} & A list of all data file formats\\
\hline
\end{DoxyParams}
This returns the list of all of the data file formats supported by the Bds\+Server\textquotesingle{}s data convertors. \Hypertarget{classBds_1_1AdminAccess_a900c3fc32e525b60068bde736326c853}\label{classBds_1_1AdminAccess_a900c3fc32e525b60068bde736326c853} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!transactionStart@{transactionStart}}
\index{transactionStart@{transactionStart}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{transactionStart()}{transactionStart()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::transaction\+Start (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Starts a set of transactions. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a900c3fc32e525b60068bde736326c853}{transaction\+Start()};

Starts a database transaction. A database transaction allows an atomic update of a set of database parameters with the option to abort the whole change.


\begin{DoxyParams}{Parameters}
{\em abort} & Abort or complete the transaction normally\\
\hline
\end{DoxyParams}
Completes a database transaction with an option to abort the changes. \Hypertarget{classBds_1_1AdminAccess_a6c8313fbc0b2b2608420241133d53c42}\label{classBds_1_1AdminAccess_a6c8313fbc0b2b2608420241133d53c42} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!transactionEnd@{transactionEnd}}
\index{transactionEnd@{transactionEnd}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{transactionEnd()}{transactionEnd()}}
{\footnotesize\ttfamily Admin\+Access\+::transaction\+End (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{abort }\end{DoxyParamCaption})}



Ends a set of transactions. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_a6c8313fbc0b2b2608420241133d53c42}{transaction\+End(\+BInt32 abort)}; \Hypertarget{classBds_1_1AdminAccess_a43327c4da01b21ccfc69653b51d0fecd}\label{classBds_1_1AdminAccess_a43327c4da01b21ccfc69653b51d0fecd} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!modeSet@{modeSet}}
\index{modeSet@{modeSet}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{modeSet()}{modeSet()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::mode\+Set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespaceBds_a857f94be30ca469ff69522b2881bb064}{Mode}}}]{mode,  }\item[{\mbox{\hyperlink{namespaceBds_a857f94be30ca469ff69522b2881bb064}{Mode}} \&}]{previous\+Mode }\end{DoxyParamCaption})}



Changes the system mode from Master to slave. 

Python\+: (\textbf{ BError} err, Mode previous\+Mode) = mode\+Set(\+Mode mode);


\begin{DoxyParams}{Parameters}
{\em mode} & The new server mode \\
\hline
{\em previous\+Mode} & The current server mode returned\\
\hline
\end{DoxyParams}
Changes the mode of a Bds\+Server\textquotesingle{}s operation. A Bds\+Server can be in Mode\+Master or Mode\+Slave modes. In Mode\+Slave it will act as a read only Bds\+Server which can be used for resiliance, data protection or for peerformance purposes. \Hypertarget{classBds_1_1AdminAccess_adb9c248e38a51faad8ea94cf41e41aa2}\label{classBds_1_1AdminAccess_adb9c248e38a51faad8ea94cf41e41aa2} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!modeSnapshotPause@{modeSnapshotPause}}
\index{modeSnapshotPause@{modeSnapshotPause}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{modeSnapshotPause()}{modeSnapshotPause()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::mode\+Snapshot\+Pause (\begin{DoxyParamCaption}\item[{\textbf{ BInt32}}]{on }\end{DoxyParamCaption})}



Enables/disables backup synchronisation pause. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_adb9c248e38a51faad8ea94cf41e41aa2}{mode\+Snapshot\+Pause(\+BInt32 on)};


\begin{DoxyParams}{Parameters}
{\em on} & Enabvle/disable pause\\
\hline
\end{DoxyParams}
Preforms a snapshot pause. When in this mode all changes to the database and data files will be blocked untill the end of the pause. This allows a backup to be performed with consistant files. \Hypertarget{classBds_1_1AdminAccess_ac80013cf73e7bc0c7369e7c26eb9c0db}\label{classBds_1_1AdminAccess_ac80013cf73e7bc0c7369e7c26eb9c0db} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!clean@{clean}}
\index{clean@{clean}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{clean()}{clean()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::clean (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classBds_1_1CleanOptions}{Clean\+Options}}}]{clean\+Options }\end{DoxyParamCaption})}



Cleans the system logs and Changes information. 

Python\+: (\textbf{ BError} err) = \doxylink{classBds_1_1AdminAccess_ac80013cf73e7bc0c7369e7c26eb9c0db}{clean(\+Clean\+Options clean\+Options)};


\begin{DoxyParams}{Parameters}
{\em clean\+Options} & Clean options. This has the options logs, changes and deleted\+Files\\
\hline
\end{DoxyParams}
This function can be used to clean up old data. It should be called once in a while to perform this work. It will clean the given items that are over a year old. \Hypertarget{classBds_1_1AdminAccess_a3f3ebd476bf139b7e9039a223ce96d4e}\label{classBds_1_1AdminAccess_a3f3ebd476bf139b7e9039a223ce96d4e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!databaseBackup@{databaseBackup}}
\index{databaseBackup@{databaseBackup}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{databaseBackup()}{databaseBackup()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::database\+Backup (\begin{DoxyParamCaption}\item[{\textbf{ BString} \&}]{ref }\end{DoxyParamCaption})}



Backup the database. 

Python\+: (\textbf{ BError} err, Python\+Str ref) = \doxylink{classBds_1_1AdminAccess_a3f3ebd476bf139b7e9039a223ce96d4e}{database\+Backup()};


\begin{DoxyParams}{Parameters}
{\em ref} & Reference and file name component\\
\hline
\end{DoxyParams}
This will perform a complede BDS database backup into a file with the given reference name. \Hypertarget{classBds_1_1AdminAccess_ac92aecbfb98cdd5f29a7261eb9eb0c1c}\label{classBds_1_1AdminAccess_ac92aecbfb98cdd5f29a7261eb9eb0c1c} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!databaseRestore@{databaseRestore}}
\index{databaseRestore@{databaseRestore}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{databaseRestore()}{databaseRestore()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::database\+Restore (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{ref,  }\item[{\textbf{ BString}}]{type }\end{DoxyParamCaption})}



Restore the database. 

Python\+: (\textbf{ BError} err) = database\+Restore(\+Python\+Str ref, Python\+Str type);


\begin{DoxyParams}{Parameters}
{\em ref} & Reference and file name component \\
\hline
{\em type} & The typed of database tables to restore. Can be admin, data, metadata or all\\
\hline
\end{DoxyParams}
This will perform a restore of the selected sets of database tables \Hypertarget{classBds_1_1AdminAccess_a82c95f22c7b70a80402c3bb8cd885d79}\label{classBds_1_1AdminAccess_a82c95f22c7b70a80402c3bb8cd885d79} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!sqlQuery@{sqlQuery}}
\index{sqlQuery@{sqlQuery}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{sqlQuery()}{sqlQuery()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::sql\+Query (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{query,  }\item[{\textbf{ BList}$<$ \textbf{ BDict}$<$ \textbf{ BString} $>$ $>$ \&}]{result }\end{DoxyParamCaption})}



A low level SQL access function. 

Python\+: (\textbf{ BError} err, \textbf{ BList}\texorpdfstring{$<$}{<}\textbf{ BDict$<$\+BString $>$} \texorpdfstring{$>$}{>} result) = sql\+Query(\+Python\+Str query);


\begin{DoxyParams}{Parameters}
{\em query} & The SQL query \\
\hline
{\em result} & A list of the returned strings from the database query\\
\hline
\end{DoxyParams}
This will perform a raw database SQL query. Use with caution! \Hypertarget{classBds_1_1AdminAccess_a1dfc73b5bc7b36c856d95f36f9099a6e}\label{classBds_1_1AdminAccess_a1dfc73b5bc7b36c856d95f36f9099a6e} 
\index{Bds::AdminAccess@{Bds::AdminAccess}!extraCall@{extraCall}}
\index{extraCall@{extraCall}!Bds::AdminAccess@{Bds::AdminAccess}}
\doxysubsubsection{\texorpdfstring{extraCall()}{extraCall()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Admin\+Access\+::extra\+Call (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{function,  }\item[{\textbf{ BString}}]{args,  }\item[{\textbf{ BString} \&}]{result }\end{DoxyParamCaption})}



A special function to add new functions to the API prior to a full API update. 

Python\+: (\textbf{ BError} err, Python\+Str result) = extra\+Call(\+Python\+Int function, Python\+Str args);


\begin{DoxyParams}{Parameters}
{\em function} & Integer number of an additional function \\
\hline
{\em args} & Parameters to the function is string form \\
\hline
{\em result} & return from the function in string form\\
\hline
\end{DoxyParams}
This has not been implemented but is there to add new functions to the API prior to a full API update 

The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{BdsC_8h}{Bds\+C.\+h}}\item 
\mbox{\hyperlink{BdsC_8cc}{Bds\+C.\+cc}}\item 
\mbox{\hyperlink{BdsLib_8dox}{Bds\+Lib.\+dox}}\item 
/src/blacknest/bds/bds/doc/\mbox{\hyperlink{BdsPython_8dox}{Bds\+Python.\+dox}}\item 
/src/blacknest/bds/bds/doc/\mbox{\hyperlink{bdsApi-extra_8dox}{bds\+Api-\/extra.\+dox}}\end{DoxyCompactItemize}
