TSIO++ Time series input/output
cmdlinefiles.h
Go to the documentation of this file.
1 
39 // include guard
40 #ifndef TSIO_CMDLINEFILES_H_VERSION
41 
42 #define TSIO_CMDLINEFILES_H_VERSION \
43  "TF_CMDLINEFILES_H 2014/01/30"
44 
45 #include<tsioxx/sfftsfile.h>
46 #include<tfxx/xcmdline.h>
47 #include<datrwxx/readany.h>
48 
49 namespace ts {
50 
51  namespace sff {
52 
83  typedef tfxx::RangeList<int> Ttracelist;
84 
90  typedef const char* Ttracelistkey;
91 
92 
103  struct SFile {
105  typedef float Tvalue;
107  typedef aff::Series<Tvalue> Tseries;
109  typedef ts::sff::File<Tseries> Tfile;
111  tfxx::cmdline::Filename arguments;
113  ts::sff::File<Tseries> data;
114  }; // struct SFile
115 
126  struct DFile {
128  typedef double Tvalue;
130  typedef aff::Series<Tvalue> Tseries;
132  typedef ts::sff::File<Tseries> Tfile;
134  tfxx::cmdline::Filename arguments;
136  ts::sff::File<Tseries> data;
137  }; // struct DFile
138 
144  typedef std::list<DFile> TDFileList;
145 
151  typedef std::list<SFile> TSFileList;
152 
153  /*======================================================================*/
154 
167  DFile readDSFF(const std::string& filename,
168  const bool& verbose=false,
169  const std::string& format=datrw::anyID(datrw::Fsff));
170 
171  /*----------------------------------------------------------------------*/
172 
187  DFile readDSFF(const std::string& filename,
188  const Ttracelist& selection,
189  const bool& verbose=false,
190  const std::string& format=datrw::anyID(datrw::Fsff));
191 
192  /*----------------------------------------------------------------------*/
193 
210  DFile readDSFF(const tfxx::cmdline::Filename& filename,
211  const bool& verbose=false,
212  Ttracelistkey tracekey="t",
213  const std::string& format=datrw::anyID(datrw::Fsff));
214 
215  /*----------------------------------------------------------------------*/
216 
233  TDFileList readDSFF(const tfxx::cmdline::Tparsed& flist,
234  const bool& verbose=false,
235  Ttracelistkey tracekey="t",
236  const std::string& format=datrw::anyID(datrw::Fsff));
237 
238  /*----------------------------------------------------------------------*/
239 
252  SFile readSSFF(const std::string& filename,
253  const bool& verbose=false,
254  const std::string& format=datrw::anyID(datrw::Fsff));
255 
256  /*----------------------------------------------------------------------*/
257 
273  SFile readSSFF(const std::string& filename,
274  const Ttracelist& selection,
275  const bool& verbose=false,
276  const std::string& format=datrw::anyID(datrw::Fsff));
277 
278  /*----------------------------------------------------------------------*/
279 
297  SFile readSSFF(const tfxx::cmdline::Filename& filename,
298  const bool& verbose=false,
299  Ttracelistkey tracekey="t",
300  const std::string& format=datrw::anyID(datrw::Fsff));
301 
302  /*----------------------------------------------------------------------*/
303 
321  TSFileList readSSFF(const tfxx::cmdline::Tparsed& flist,
322  const bool& verbose=false,
323  Ttracelistkey tracekey="t",
324  const std::string& format=datrw::anyID(datrw::Fsff));
325 
326  /*======================================================================*/
327 
340  DFile readDSFF(const std::string& filename,
341  const bool& verbose=false,
342  const datrw::Eformat& format=datrw::Fsff);
343 
344  /*----------------------------------------------------------------------*/
345 
360  DFile readDSFF(const std::string& filename,
361  const Ttracelist& selection,
362  const bool& verbose=false,
363  const datrw::Eformat& format=datrw::Fsff);
364 
365  /*----------------------------------------------------------------------*/
366 
383  DFile readDSFF(const tfxx::cmdline::Filename& filename,
384  const bool& verbose=false,
385  Ttracelistkey tracekey="t",
386  const datrw::Eformat& format=datrw::Fsff);
387 
388  /*----------------------------------------------------------------------*/
389 
406  TDFileList readDSFF(const tfxx::cmdline::Tparsed& flist,
407  const bool& verbose=false,
408  Ttracelistkey tracekey="t",
409  const datrw::Eformat& format=datrw::Fsff);
410 
411  /*----------------------------------------------------------------------*/
412 
425  SFile readSSFF(const std::string& filename,
426  const bool& verbose=false,
427  const datrw::Eformat& format=datrw::Fsff);
428 
429  /*----------------------------------------------------------------------*/
430 
446  SFile readSSFF(const std::string& filename,
447  const Ttracelist& selection,
448  const bool& verbose=false,
449  const datrw::Eformat& format=datrw::Fsff);
450 
451  /*----------------------------------------------------------------------*/
452 
470  SFile readSSFF(const tfxx::cmdline::Filename& filename,
471  const bool& verbose=false,
472  Ttracelistkey tracekey="t",
473  const datrw::Eformat& format=datrw::Fsff);
474 
475  /*----------------------------------------------------------------------*/
476 
494  TSFileList readSSFF(const tfxx::cmdline::Tparsed& flist,
495  const bool& verbose=false,
496  Ttracelistkey tracekey="t",
497  const datrw::Eformat& format=datrw::Fsff);
500  } // namespace sff
501 } // namespace ts
502 
503 #endif // TSIO_CMDLINEFILES_H_VERSION (includeguard)
504 
505 /* ----- END OF cmdlinefiles.h ----- */
ts::sff::DFile
structure to contain file data together with command line arguments.
Definition: cmdlinefiles.h:126
ts::sff::DFile::Tseries
aff::Series< Tvalue > Tseries
container to be used
Definition: cmdlinefiles.h:130
ts::sff::DFile::Tvalue
double Tvalue
provides reading into doubles
Definition: cmdlinefiles.h:128
ts::sff::readDSFF
DFile readDSFF(const std::string &filename, const bool &verbose, const std::string &format)
read complete SFF file
Definition: cmdlinefiles.cc:60
ts::sff::SFile::Tseries
aff::Series< Tvalue > Tseries
container to be used
Definition: cmdlinefiles.h:107
ts::sff::TDFileList
std::list< DFile > TDFileList
complete list of files.
Definition: cmdlinefiles.h:144
ts::sff::DFile::data
ts::sff::File< Tseries > data
container to hold data headers and samples
Definition: cmdlinefiles.h:136
ts::sff::DFile::Tfile
ts::sff::File< Tseries > Tfile
file container
Definition: cmdlinefiles.h:132
ts::sff::SFile::Tvalue
float Tvalue
provides reading into doubles
Definition: cmdlinefiles.h:105
ts::sff::SFile::Tfile
ts::sff::File< Tseries > Tfile
file container
Definition: cmdlinefiles.h:109
ts::sff::SFile
structure to contain file data together with command line arguments (single precision).
Definition: cmdlinefiles.h:103
ts
Outer namespace.
Definition: cmdlinefiles.cc:46
ts::sff::DFile::arguments
tfxx::cmdline::Filename arguments
command line arguments
Definition: cmdlinefiles.h:134
ts::sff::Ttracelistkey
const char * Ttracelistkey
type of trace selection key.
Definition: cmdlinefiles.h:90
ts::sff::TSFileList
std::list< SFile > TSFileList
complete list of files (single precision version).
Definition: cmdlinefiles.h:151
ts::sff::SFile::data
ts::sff::File< Tseries > data
container to hold data headers and samples
Definition: cmdlinefiles.h:113
ts::sff::readSSFF
SFile readSSFF(const std::string &filename, const bool &verbose, const std::string &format)
read complete SFF file
Definition: cmdlinefiles.cc:51
ts::sff::Ttracelist
tfxx::RangeList< int > Ttracelist
type of trace selection list.
Definition: cmdlinefiles.h:83
sfftsfile.h
data file container for SFF TimeSeries (prototypes)
ts::sff::SFile::arguments
tfxx::cmdline::Filename arguments
command line arguments
Definition: cmdlinefiles.h:111