\doxysection{Bds\+::Data\+File\+Info Class Reference}
\hypertarget{classBds_1_1DataFileInfo}{}\label{classBds_1_1DataFileInfo}\index{Bds::DataFileInfo@{Bds::DataFileInfo}}


This class defines information on a \doxylink{classBds_1_1Sensor}{Sensor} data file.  




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

Inheritance diagram for Bds\+::Data\+File\+Info\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classBds_1_1DataFileInfo}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classBds_1_1DataFileInfo_a4e65565a146f0ab6ff848a7a403d78cb}{Data\+File\+Info}} (\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1DataFileInfo_af5830906815b243658485de13c079c8f}{id}}=0, \textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_a091f95bef601088928179df1cb8dd228}{start\+Time}}=\textbf{ BTime\+Stamp}(), \textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_ad2e02504389fe6fc445013310114d06c}{end\+Time}}=\textbf{ BTime\+Stamp}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a9c6a40e1cbe5e11be74c911639a9532e}{location}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a5ad460912eddd92af9dd6d90fa5d812a}{format}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_aed8943d69eaa07add8f1094531a2d15a}{url}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a9eb5a09e4717d72130f07d571debeb80}{stream}}=\textbf{ BString}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a35e261582911d64f0cb9c8e4931a843e}{comment}}=\textbf{ BString}(), \textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1DataFileInfo_a29bffb3590c3e4c5e0f2100f04b7031d}{import\+User\+Id}}=0, \textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_a368082a18facd7cef658e06c8ce2658a}{import\+Time}}=\textbf{ BTime\+Stamp}(), \textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_ae929c3ae75d939755df1506131ca50b5}{state}}=\textbf{ BString}())
\item 
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classBds_1_1DataFileInfo_afdc566d4e2ce0e4ad654c55065167e25}{get\+Type}} () const
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1DataFileInfo_aae29a3b3b8c1b89c1a0f6f0e3ae7de81}{set\+Members}} (\textbf{ BDict\+String} \&members)
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1DataFileInfo_a18ac0b280662b5eecbc93495b6d4471e}{set\+Member}} (\textbf{ BString} name, \textbf{ BString} value)
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1DataFileInfo_ad7bf2322a5bf4087617166110a98ab29}{get\+Members}} (\textbf{ BDict\+String} \&members)
\item 
\textbf{ BError} \mbox{\hyperlink{classBds_1_1DataFileInfo_a0d056fe4910f21793c138629d0a660a8}{get\+Member}} (\textbf{ BString} name, \textbf{ BString} \&value)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \textbf{ BObj}}
\begin{DoxyCompactItemize}
\item 
\textbf{ BObj} ()
\item 
virtual \textbf{ \texorpdfstring{$\sim$}{\string~}\+BObj} ()
\item 
virtual const char \texorpdfstring{$\ast$}{*} \textbf{ get\+Type} () const
\item 
virtual const \textbf{ BObj\+Member} \texorpdfstring{$\ast$}{*} \textbf{ get\+Members} () const
\item 
virtual \textbf{ BError} \textbf{ get\+Members} (\textbf{ BDict\+String} \&members)
\item 
virtual \textbf{ BError} \textbf{ get\+Member} (\textbf{ BString} name, \textbf{ BString} \&value)
\item 
virtual \textbf{ BError} \textbf{ set\+Members} (\textbf{ BDict\+String} \&members)
\item 
virtual \textbf{ BError} \textbf{ set\+Member} (\textbf{ BString} name, \textbf{ BString} value)
\item 
virtual void \textbf{ members\+Print} () const
\item 
virtual \textbf{ BString} \textbf{ get\+Debug\+String} ()
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1DataFileInfo_af5830906815b243658485de13c079c8f}{id}}
\begin{DoxyCompactList}\small\item\em Unique ID when stored in a database or for other uses. \end{DoxyCompactList}\item 
\textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_a091f95bef601088928179df1cb8dd228}{start\+Time}}
\begin{DoxyCompactList}\small\item\em The Start Time. \end{DoxyCompactList}\item 
\textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_ad2e02504389fe6fc445013310114d06c}{end\+Time}}
\begin{DoxyCompactList}\small\item\em The End Time. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a9c6a40e1cbe5e11be74c911639a9532e}{location}}
\begin{DoxyCompactList}\small\item\em The storage location. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a5ad460912eddd92af9dd6d90fa5d812a}{format}}
\begin{DoxyCompactList}\small\item\em The data format. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_aed8943d69eaa07add8f1094531a2d15a}{url}}
\begin{DoxyCompactList}\small\item\em The URL for file access. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a9eb5a09e4717d72130f07d571debeb80}{stream}}
\begin{DoxyCompactList}\small\item\em The real-\/time data stream. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_a35e261582911d64f0cb9c8e4931a843e}{comment}}
\begin{DoxyCompactList}\small\item\em A comment on the file. \end{DoxyCompactList}\item 
\textbf{ BUInt32} \mbox{\hyperlink{classBds_1_1DataFileInfo_a29bffb3590c3e4c5e0f2100f04b7031d}{import\+User\+Id}}
\begin{DoxyCompactList}\small\item\em The user ID of the importing user. \end{DoxyCompactList}\item 
\textbf{ BTime\+Stamp} \mbox{\hyperlink{classBds_1_1DataFileInfo_a368082a18facd7cef658e06c8ce2658a}{import\+Time}}
\begin{DoxyCompactList}\small\item\em The Time the data was imported. \end{DoxyCompactList}\item 
\textbf{ BString} \mbox{\hyperlink{classBds_1_1DataFileInfo_ae929c3ae75d939755df1506131ca50b5}{state}}
\begin{DoxyCompactList}\small\item\em Status info on the import (importing, realtime, failed, ok etc) \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This class defines information on a \doxylink{classBds_1_1Sensor}{Sensor} data file. 

The raw sensor data for a seismic channel is stored in files in the BDS system. This class defines the database entry that describes this file, its storage location and status. A single file can store one or more channels of seismic data in different formats although noramlly the BDS data file format is used. 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classBds_1_1DataFileInfo_a4e65565a146f0ab6ff848a7a403d78cb}\label{classBds_1_1DataFileInfo_a4e65565a146f0ab6ff848a7a403d78cb} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!DataFileInfo@{DataFileInfo}}
\index{DataFileInfo@{DataFileInfo}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{DataFileInfo()}{DataFileInfo()}}
{\footnotesize\ttfamily Bds\+::\+Data\+File\+Info\+::\+Data\+File\+Info (\begin{DoxyParamCaption}\item[{\textbf{ BUInt32}}]{id = {\ttfamily 0},  }\item[{\textbf{ BTime\+Stamp}}]{start\+Time = {\ttfamily \textbf{ BTime\+Stamp}()},  }\item[{\textbf{ BTime\+Stamp}}]{end\+Time = {\ttfamily \textbf{ BTime\+Stamp}()},  }\item[{\textbf{ BString}}]{location = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{format = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{url = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{stream = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BString}}]{comment = {\ttfamily \textbf{ BString}()},  }\item[{\textbf{ BUInt32}}]{import\+User\+Id = {\ttfamily 0},  }\item[{\textbf{ BTime\+Stamp}}]{import\+Time = {\ttfamily \textbf{ BTime\+Stamp}()},  }\item[{\textbf{ BString}}]{state = {\ttfamily \textbf{ BString}()} }\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\Hypertarget{classBds_1_1DataFileInfo_afdc566d4e2ce0e4ad654c55065167e25}\label{classBds_1_1DataFileInfo_afdc566d4e2ce0e4ad654c55065167e25} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!getType@{getType}}
\index{getType@{getType}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily const char \texorpdfstring{$\ast$}{*} Bds\+::\+Data\+File\+Info\+::get\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \textbf{ BObj}.

\Hypertarget{classBds_1_1DataFileInfo_aae29a3b3b8c1b89c1a0f6f0e3ae7de81}\label{classBds_1_1DataFileInfo_aae29a3b3b8c1b89c1a0f6f0e3ae7de81} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!setMembers@{setMembers}}
\index{setMembers@{setMembers}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{setMembers()}{setMembers()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Data\+File\+Info\+::set\+Members (\begin{DoxyParamCaption}\item[{\textbf{ BDict\+String} \&}]{members }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \textbf{ BObj}.

\Hypertarget{classBds_1_1DataFileInfo_a18ac0b280662b5eecbc93495b6d4471e}\label{classBds_1_1DataFileInfo_a18ac0b280662b5eecbc93495b6d4471e} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!setMember@{setMember}}
\index{setMember@{setMember}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{setMember()}{setMember()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Data\+File\+Info\+::set\+Member (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{name,  }\item[{\textbf{ BString}}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \textbf{ BObj}.

\Hypertarget{classBds_1_1DataFileInfo_ad7bf2322a5bf4087617166110a98ab29}\label{classBds_1_1DataFileInfo_ad7bf2322a5bf4087617166110a98ab29} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!getMembers@{getMembers}}
\index{getMembers@{getMembers}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{getMembers()}{getMembers()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Data\+File\+Info\+::get\+Members (\begin{DoxyParamCaption}\item[{\textbf{ BDict\+String} \&}]{members }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \textbf{ BObj}.

\Hypertarget{classBds_1_1DataFileInfo_a0d056fe4910f21793c138629d0a660a8}\label{classBds_1_1DataFileInfo_a0d056fe4910f21793c138629d0a660a8} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!getMember@{getMember}}
\index{getMember@{getMember}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{getMember()}{getMember()}}
{\footnotesize\ttfamily \textbf{ BError} Bds\+::\+Data\+File\+Info\+::get\+Member (\begin{DoxyParamCaption}\item[{\textbf{ BString}}]{name,  }\item[{\textbf{ BString} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reimplemented from \textbf{ BObj}.



\doxysubsection{Member Data Documentation}
\Hypertarget{classBds_1_1DataFileInfo_af5830906815b243658485de13c079c8f}\label{classBds_1_1DataFileInfo_af5830906815b243658485de13c079c8f} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!id@{id}}
\index{id@{id}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{id}{id}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Data\+File\+Info\+::id}



Unique ID when stored in a database or for other uses. 

\Hypertarget{classBds_1_1DataFileInfo_a091f95bef601088928179df1cb8dd228}\label{classBds_1_1DataFileInfo_a091f95bef601088928179df1cb8dd228} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!startTime@{startTime}}
\index{startTime@{startTime}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{startTime}{startTime}}
{\footnotesize\ttfamily \textbf{ BTime\+Stamp} Bds\+::\+Data\+File\+Info\+::start\+Time}



The Start Time. 

\Hypertarget{classBds_1_1DataFileInfo_ad2e02504389fe6fc445013310114d06c}\label{classBds_1_1DataFileInfo_ad2e02504389fe6fc445013310114d06c} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!endTime@{endTime}}
\index{endTime@{endTime}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{endTime}{endTime}}
{\footnotesize\ttfamily \textbf{ BTime\+Stamp} Bds\+::\+Data\+File\+Info\+::end\+Time}



The End Time. 

\Hypertarget{classBds_1_1DataFileInfo_a9c6a40e1cbe5e11be74c911639a9532e}\label{classBds_1_1DataFileInfo_a9c6a40e1cbe5e11be74c911639a9532e} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!location@{location}}
\index{location@{location}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{location}{location}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::location}



The storage location. 

\Hypertarget{classBds_1_1DataFileInfo_a5ad460912eddd92af9dd6d90fa5d812a}\label{classBds_1_1DataFileInfo_a5ad460912eddd92af9dd6d90fa5d812a} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!format@{format}}
\index{format@{format}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{format}{format}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::format}



The data format. 

\Hypertarget{classBds_1_1DataFileInfo_aed8943d69eaa07add8f1094531a2d15a}\label{classBds_1_1DataFileInfo_aed8943d69eaa07add8f1094531a2d15a} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!url@{url}}
\index{url@{url}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{url}{url}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::url}



The URL for file access. 

\Hypertarget{classBds_1_1DataFileInfo_a9eb5a09e4717d72130f07d571debeb80}\label{classBds_1_1DataFileInfo_a9eb5a09e4717d72130f07d571debeb80} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!stream@{stream}}
\index{stream@{stream}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{stream}{stream}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::stream}



The real-\/time data stream. 

\Hypertarget{classBds_1_1DataFileInfo_a35e261582911d64f0cb9c8e4931a843e}\label{classBds_1_1DataFileInfo_a35e261582911d64f0cb9c8e4931a843e} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!comment@{comment}}
\index{comment@{comment}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{comment}{comment}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::comment}



A comment on the file. 

\Hypertarget{classBds_1_1DataFileInfo_a29bffb3590c3e4c5e0f2100f04b7031d}\label{classBds_1_1DataFileInfo_a29bffb3590c3e4c5e0f2100f04b7031d} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!importUserId@{importUserId}}
\index{importUserId@{importUserId}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{importUserId}{importUserId}}
{\footnotesize\ttfamily \textbf{ BUInt32} Bds\+::\+Data\+File\+Info\+::import\+User\+Id}



The user ID of the importing user. 

\Hypertarget{classBds_1_1DataFileInfo_a368082a18facd7cef658e06c8ce2658a}\label{classBds_1_1DataFileInfo_a368082a18facd7cef658e06c8ce2658a} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!importTime@{importTime}}
\index{importTime@{importTime}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{importTime}{importTime}}
{\footnotesize\ttfamily \textbf{ BTime\+Stamp} Bds\+::\+Data\+File\+Info\+::import\+Time}



The Time the data was imported. 

\Hypertarget{classBds_1_1DataFileInfo_ae929c3ae75d939755df1506131ca50b5}\label{classBds_1_1DataFileInfo_ae929c3ae75d939755df1506131ca50b5} 
\index{Bds::DataFileInfo@{Bds::DataFileInfo}!state@{state}}
\index{state@{state}!Bds::DataFileInfo@{Bds::DataFileInfo}}
\doxysubsubsection{\texorpdfstring{state}{state}}
{\footnotesize\ttfamily \textbf{ BString} Bds\+::\+Data\+File\+Info\+::state}



Status info on the import (importing, realtime, failed, ok etc) 



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}
