\doxysection{Bds\+::Selection Class Reference}
\hypertarget{classBds_1_1Selection}{}\label{classBds_1_1Selection}\index{Bds::Selection@{Bds::Selection}}


This class defines a generic Metadata or \doxylink{classBds_1_1Sensor}{Sensor} data selection.  




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

\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classBds_1_1Selection_a137c863727a225e9dfbee758c1eab5b2}{Selection}} (\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_acfaea84d49dbfdd3ee343a30993e9fc7}{id}}=0, \mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}} \mbox{\hyperlink{classBds_1_1Selection_ade09b54ae803e267472e4ad51f3967ff}{range}}=\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}}(), \textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1Selection_a68a873c546777e835a28be6f2fd9588b}{start\+Time}}=\textbf{ BTime\+Stamp}(), \textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1Selection_a0f4897d22d413665d315c1f8b8fc0210}{end\+Time}}=\textbf{ BTime\+Stamp}(), \textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}} $>$ \mbox{\hyperlink{classBds_1_1Selection_a10e8033fb7bf95c2697d733b73990b5f}{channels}}=\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}} $>$(), \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_aefaab1b0fffee89510837e38d7858f0d}{channel\+Id}}=0, \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a826d3dc2d8f9a29a295fdc97a59f7aa4}{digitiser\+Id}}=0, \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a8a04aebc8ae0f5a6eb24558810bce836}{sensor\+Id}}=0, \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a265c763d841ad2a0cd24799bbb914508}{sensor\+Old\+Id}}=0, \textbf{ BInt32} \mbox{\hyperlink{classBds_1_1Selection_ab469c825a0c4befa0164e87dee11142b}{complete\+Segments}}=0, \textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_aa728249ef88671f8d15b967da57ce2a4}{calibration\+Name}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_aeb7a2f62d237a3f784d1e9999ecd585c}{array}}=\textbf{ BString}(), \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a7a53853298c5b0a6ee39d9e5385456e2}{event\+Id}}=0, \textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_ae24c13dab1d1b69c0625581e56bda67f}{name}}=\textbf{ BString}(), \mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}} \mbox{\hyperlink{classBds_1_1Selection_acdd364d854158204a8226d26c5facb0d}{location\+Select}}=\mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_afd2775a75dbfed465f86498c138ba72a}{data\+Types}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_a49b1a4175522f6c29304cbddf265f290}{exclude\+Channels}}=\textbf{ BString}())
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_acfaea84d49dbfdd3ee343a30993e9fc7}{id}}
\begin{DoxyCompactList}\small\item\em The ID of the record to return. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}} \mbox{\hyperlink{classBds_1_1Selection_ade09b54ae803e267472e4ad51f3967ff}{range}}
\begin{DoxyCompactList}\small\item\em The range of data to return. \end{DoxyCompactList}\item 
\textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1Selection_a68a873c546777e835a28be6f2fd9588b}{start\+Time}}
\begin{DoxyCompactList}\small\item\em The Start Time. \end{DoxyCompactList}\item 
\textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1Selection_a0f4897d22d413665d315c1f8b8fc0210}{end\+Time}}
\begin{DoxyCompactList}\small\item\em The End Time. \end{DoxyCompactList}\item 
\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}} $>$ \mbox{\hyperlink{classBds_1_1Selection_a10e8033fb7bf95c2697d733b73990b5f}{channels}}
\begin{DoxyCompactList}\small\item\em The data channels to select. \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_aefaab1b0fffee89510837e38d7858f0d}{channel\+Id}}
\begin{DoxyCompactList}\small\item\em The \doxylink{classBds_1_1Channel}{Channel} id. \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a826d3dc2d8f9a29a295fdc97a59f7aa4}{digitiser\+Id}}
\begin{DoxyCompactList}\small\item\em The \doxylink{classBds_1_1Digitiser}{Digitiser} id. \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a8a04aebc8ae0f5a6eb24558810bce836}{sensor\+Id}}
\begin{DoxyCompactList}\small\item\em The \doxylink{classBds_1_1Sensor}{Sensor} id. \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a265c763d841ad2a0cd24799bbb914508}{sensor\+Old\+Id}}
\begin{DoxyCompactList}\small\item\em The \doxylink{classBds_1_1Sensor}{Sensor} old id. \end{DoxyCompactList}\item 
\textbf{ BInt32} \mbox{\hyperlink{classBds_1_1Selection_ab469c825a0c4befa0164e87dee11142b}{complete\+Segments}}
\begin{DoxyCompactList}\small\item\em Do not clip the segment times to match the required time period. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_aa728249ef88671f8d15b967da57ce2a4}{calibration\+Name}}
\begin{DoxyCompactList}\small\item\em \doxylink{classBds_1_1Calibration}{Calibration} name to use. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_aeb7a2f62d237a3f784d1e9999ecd585c}{array}}
\begin{DoxyCompactList}\small\item\em Channels are based on the given array (for array offsets) \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1Selection_a7a53853298c5b0a6ee39d9e5385456e2}{event\+Id}}
\begin{DoxyCompactList}\small\item\em A particular event\textquotesingle{}s ID. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_ae24c13dab1d1b69c0625581e56bda67f}{name}}
\begin{DoxyCompactList}\small\item\em Match the name, title or some other string in the objects to select. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}} \mbox{\hyperlink{classBds_1_1Selection_acdd364d854158204a8226d26c5facb0d}{location\+Select}}
\begin{DoxyCompactList}\small\item\em Which locations to select, those for stations, channels or all of them when used in a location\+Get\+List() call. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_afd2775a75dbfed465f86498c138ba72a}{data\+Types}}
\begin{DoxyCompactList}\small\item\em Place holder as yet for\+: A comma separated list of \doxylink{classBds_1_1Channel}{Channel} data\+Types to select when returning Channels. If set to null all \doxylink{classBds_1_1Channel}{Channel} data\+Types are returned. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1Selection_a49b1a4175522f6c29304cbddf265f290}{exclude\+Channels}}
\begin{DoxyCompactList}\small\item\em Comma separated wildcard list of channels to be excluded. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This class defines a generic Metadata or \doxylink{classBds_1_1Sensor}{Sensor} data selection. 

This defines a set of selection criteria when selecting items from the BDS Metadata or \doxylink{classBds_1_1Sensor}{Sensor} data sets. The fields, when set, limit the items returned as defined by the setting fields provided. In effect these have an \"{}\+AND\"{} type of function with the parameters provided. Most of the string parameters can be provided as regular expressions. The core section fields are the start\+Time, end\+Time and channels fields. As well as thses there are some specific parameters like\+: channel\+Id, digitiser\+Id, sensor\+Id etc which are used with specific data selection functions. 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classBds_1_1Selection_a137c863727a225e9dfbee758c1eab5b2}\label{classBds_1_1Selection_a137c863727a225e9dfbee758c1eab5b2} 
\index{Bds::Selection@{Bds::Selection}!Selection@{Selection}}
\index{Selection@{Selection}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{Selection()}{Selection()}}
{\footnotesize\ttfamily Bds\+::\+Selection\+::\+Selection (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id = {\ttfamily 0},  }\item[{\mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}}}]{range = {\ttfamily \mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}}()},  }\item[{\textbf{ BTime\+Stamp}}]{start\+Time = {\ttfamily \textbf{ BTime\+Stamp}()},  }\item[{\textbf{ BTime\+Stamp}}]{end\+Time = {\ttfamily \textbf{ BTime\+Stamp}()},  }\item[{\textbf{ BList}$<$ \mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}} $>$}]{channels = {\ttfamily \textbf{ BList}$<$\mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}}~$>$()},  }\item[{\textbf{ BUInt32}}]{channel\+Id = {\ttfamily 0},  }\item[{\textbf{ BUInt32}}]{digitiser\+Id = {\ttfamily 0},  }\item[{\textbf{ BUInt32}}]{sensor\+Id = {\ttfamily 0},  }\item[{\textbf{ BUInt32}}]{sensor\+Old\+Id = {\ttfamily 0},  }\item[{\textbf{ BInt32}}]{complete\+Segments = {\ttfamily 0},  }\item[{\textbf{ BString}}]{calibration\+Name = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{array = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BUInt32}}]{event\+Id = {\ttfamily 0},  }\item[{\textbf{ BString}}]{name = {\ttfamily \textbf{ BString}()},  }\item[{\mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}}}]{location\+Select = {\ttfamily \mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}}()},  }\item[{\textbf{ BString}}]{data\+Types = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{exclude\+Channels = {\ttfamily \textbf{ BString}()} }\end{DoxyParamCaption})}



\doxysubsection{Member Data Documentation}
\Hypertarget{classBds_1_1Selection_acfaea84d49dbfdd3ee343a30993e9fc7}\label{classBds_1_1Selection_acfaea84d49dbfdd3ee343a30993e9fc7} 
\index{Bds::Selection@{Bds::Selection}!id@{id}}
\index{id@{id}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{id}{id}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::id}



The ID of the record to return. 

\Hypertarget{classBds_1_1Selection_ade09b54ae803e267472e4ad51f3967ff}\label{classBds_1_1Selection_ade09b54ae803e267472e4ad51f3967ff} 
\index{Bds::Selection@{Bds::Selection}!range@{range}}
\index{range@{range}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{range}{range}}
{\footnotesize\ttfamily \mbox{\hyperlink{classBds_1_1ListRange}{List\+Range}} Bds\+::\+Selection\+::range}



The range of data to return. 

\Hypertarget{classBds_1_1Selection_a68a873c546777e835a28be6f2fd9588b}\label{classBds_1_1Selection_a68a873c546777e835a28be6f2fd9588b} 
\index{Bds::Selection@{Bds::Selection}!startTime@{startTime}}
\index{startTime@{startTime}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{startTime}{startTime}}
{\footnotesize\ttfamily \textbf{ BTime\+Stamp} Bds\+::\+Selection\+::start\+Time}



The Start Time. 

\Hypertarget{classBds_1_1Selection_a0f4897d22d413665d315c1f8b8fc0210}\label{classBds_1_1Selection_a0f4897d22d413665d315c1f8b8fc0210} 
\index{Bds::Selection@{Bds::Selection}!endTime@{endTime}}
\index{endTime@{endTime}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{endTime}{endTime}}
{\footnotesize\ttfamily \textbf{ BTime\+Stamp} Bds\+::\+Selection\+::end\+Time}



The End Time. 

\Hypertarget{classBds_1_1Selection_a10e8033fb7bf95c2697d733b73990b5f}\label{classBds_1_1Selection_a10e8033fb7bf95c2697d733b73990b5f} 
\index{Bds::Selection@{Bds::Selection}!channels@{channels}}
\index{channels@{channels}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{channels}{channels}}
{\footnotesize\ttfamily \textbf{ BList}$<$\mbox{\hyperlink{classBds_1_1SelectionChannel}{Selection\+Channel}} $>$ Bds\+::\+Selection\+::channels}



The data channels to select. 

\Hypertarget{classBds_1_1Selection_aefaab1b0fffee89510837e38d7858f0d}\label{classBds_1_1Selection_aefaab1b0fffee89510837e38d7858f0d} 
\index{Bds::Selection@{Bds::Selection}!channelId@{channelId}}
\index{channelId@{channelId}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{channelId}{channelId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::channel\+Id}



The \doxylink{classBds_1_1Channel}{Channel} id. 

\Hypertarget{classBds_1_1Selection_a826d3dc2d8f9a29a295fdc97a59f7aa4}\label{classBds_1_1Selection_a826d3dc2d8f9a29a295fdc97a59f7aa4} 
\index{Bds::Selection@{Bds::Selection}!digitiserId@{digitiserId}}
\index{digitiserId@{digitiserId}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{digitiserId}{digitiserId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::digitiser\+Id}



The \doxylink{classBds_1_1Digitiser}{Digitiser} id. 

\Hypertarget{classBds_1_1Selection_a8a04aebc8ae0f5a6eb24558810bce836}\label{classBds_1_1Selection_a8a04aebc8ae0f5a6eb24558810bce836} 
\index{Bds::Selection@{Bds::Selection}!sensorId@{sensorId}}
\index{sensorId@{sensorId}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{sensorId}{sensorId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::sensor\+Id}



The \doxylink{classBds_1_1Sensor}{Sensor} id. 

\Hypertarget{classBds_1_1Selection_a265c763d841ad2a0cd24799bbb914508}\label{classBds_1_1Selection_a265c763d841ad2a0cd24799bbb914508} 
\index{Bds::Selection@{Bds::Selection}!sensorOldId@{sensorOldId}}
\index{sensorOldId@{sensorOldId}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{sensorOldId}{sensorOldId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::sensor\+Old\+Id}



The \doxylink{classBds_1_1Sensor}{Sensor} old id. 

\Hypertarget{classBds_1_1Selection_ab469c825a0c4befa0164e87dee11142b}\label{classBds_1_1Selection_ab469c825a0c4befa0164e87dee11142b} 
\index{Bds::Selection@{Bds::Selection}!completeSegments@{completeSegments}}
\index{completeSegments@{completeSegments}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{completeSegments}{completeSegments}}
{\footnotesize\ttfamily \textbf{ BInt32} Bds\+::\+Selection\+::complete\+Segments}



Do not clip the segment times to match the required time period. 

\Hypertarget{classBds_1_1Selection_aa728249ef88671f8d15b967da57ce2a4}\label{classBds_1_1Selection_aa728249ef88671f8d15b967da57ce2a4} 
\index{Bds::Selection@{Bds::Selection}!calibrationName@{calibrationName}}
\index{calibrationName@{calibrationName}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{calibrationName}{calibrationName}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Selection\+::calibration\+Name}



\doxylink{classBds_1_1Calibration}{Calibration} name to use. 

\Hypertarget{classBds_1_1Selection_aeb7a2f62d237a3f784d1e9999ecd585c}\label{classBds_1_1Selection_aeb7a2f62d237a3f784d1e9999ecd585c} 
\index{Bds::Selection@{Bds::Selection}!array@{array}}
\index{array@{array}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{array}{array}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Selection\+::array}



Channels are based on the given array (for array offsets) 

\Hypertarget{classBds_1_1Selection_a7a53853298c5b0a6ee39d9e5385456e2}\label{classBds_1_1Selection_a7a53853298c5b0a6ee39d9e5385456e2} 
\index{Bds::Selection@{Bds::Selection}!eventId@{eventId}}
\index{eventId@{eventId}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{eventId}{eventId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Selection\+::event\+Id}



A particular event\textquotesingle{}s ID. 

\Hypertarget{classBds_1_1Selection_ae24c13dab1d1b69c0625581e56bda67f}\label{classBds_1_1Selection_ae24c13dab1d1b69c0625581e56bda67f} 
\index{Bds::Selection@{Bds::Selection}!name@{name}}
\index{name@{name}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{name}{name}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Selection\+::name}



Match the name, title or some other string in the objects to select. 

\Hypertarget{classBds_1_1Selection_acdd364d854158204a8226d26c5facb0d}\label{classBds_1_1Selection_acdd364d854158204a8226d26c5facb0d} 
\index{Bds::Selection@{Bds::Selection}!locationSelect@{locationSelect}}
\index{locationSelect@{locationSelect}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{locationSelect}{locationSelect}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespaceBds_a1bfeb6de6b012b4aa8b25065449beb41}{Location\+Select}} Bds\+::\+Selection\+::location\+Select}



Which locations to select, those for stations, channels or all of them when used in a location\+Get\+List() call. 

\Hypertarget{classBds_1_1Selection_afd2775a75dbfed465f86498c138ba72a}\label{classBds_1_1Selection_afd2775a75dbfed465f86498c138ba72a} 
\index{Bds::Selection@{Bds::Selection}!dataTypes@{dataTypes}}
\index{dataTypes@{dataTypes}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{dataTypes}{dataTypes}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Selection\+::data\+Types}



Place holder as yet for\+: A comma separated list of \doxylink{classBds_1_1Channel}{Channel} data\+Types to select when returning Channels. If set to null all \doxylink{classBds_1_1Channel}{Channel} data\+Types are returned. 

\Hypertarget{classBds_1_1Selection_a49b1a4175522f6c29304cbddf265f290}\label{classBds_1_1Selection_a49b1a4175522f6c29304cbddf265f290} 
\index{Bds::Selection@{Bds::Selection}!excludeChannels@{excludeChannels}}
\index{excludeChannels@{excludeChannels}!Bds::Selection@{Bds::Selection}}
\doxysubsubsection{\texorpdfstring{excludeChannels}{excludeChannels}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Selection\+::exclude\+Channels}



Comma separated wildcard list of channels to be excluded. 



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{BdsD_8h}{Bds\+D.\+h}}\item 
\mbox{\hyperlink{BdsD_8cc}{Bds\+D.\+cc}}\end{DoxyCompactItemize}
