Commit 36ce5c60 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

libdatrwxx [WP][DOC]: replace group ID tsoft by group_tsoft

parent 8bcceb06
/*! \file tsoft.h
* \brief classes for TSOFT in SFF (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -57,7 +57,7 @@ namespace datrw {
/*! \brief class to read TSOFT data
*
* \ingroup tsoft
* \ingroup group_tsoft
*/
class itsoftstream: public idatstream {
public:
......
/*! \file channeltranslation.cc
* \brief translate TSOFT channel name (they are too long for SFF headers) (implementation)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -50,7 +50,7 @@ namespace datrw {
namespace tsoft {
/*! \brief global variable: channel name translation table
* \ingroup tsoft
* \ingroup group_tsoft
*
* This table is specific for SG056 at BFO.
* Sensor data conversion codes are assigned based on GWR document
......
/*! \file channeltranslation.h
* \brief translate TSOFT channel name (they are too long for SFF headers) (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -49,7 +49,7 @@ namespace datrw {
namespace tsoft {
/*! \brief DDAS3 sensor data conversion codes
* \ingroup tsoft
* \ingroup group_tsoft
* Sensor data conversion codes as defined in GWR document
* DDAS3_man_technical_ch5_UIPCsoftware_2010-07-16_BFO-Excerpt
*/
......@@ -90,7 +90,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief struct to hold a pair of channel names
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct Channel {
//! \brief channel description used in TSOFT
......@@ -104,7 +104,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief hold TSOFT channel description
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct TSOFTchannelid
{
......@@ -114,7 +114,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief hold SFF channel description
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct SFFchannelid
{
......@@ -124,7 +124,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief hold channel description
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct ChannelDescription
{
......@@ -136,7 +136,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief global variable: channel name translation table
* \ingroup tsoft
* \ingroup group_tsoft
*/
extern const Channel translationtable[];
......@@ -144,49 +144,49 @@ namespace datrw {
// functions
/*! \brief split TSOFT channel description
* \ingroup tsoft
* \ingroup group_tsoft
*/
TSOFTchannelid tchannelid(const Channel& ci);
/*----------------------------------------------------------------------*/
/*! \brief split SFF channel description
* \ingroup tsoft
* \ingroup group_tsoft
*/
SFFchannelid schannelid(const Channel& ci);
/*----------------------------------------------------------------------*/
/*! \brief report translation table
* \ingroup tsoft
* \ingroup group_tsoft
*/
void reporttranslation(std::ostream& os);
/*----------------------------------------------------------------------*/
/*! \brief report comments from 1s files
* \ingroup tsoft
* \ingroup group_tsoft
*/
void reportdatacomments(std::ostream& os);
/*----------------------------------------------------------------------*/
/*! \brief check uniqueness of translation table
* \ingroup tsoft
* \ingroup group_tsoft
*/
bool translationisunique(const bool& verbose=true);
/*----------------------------------------------------------------------*/
/*! \brief return SFF channel ID for given TSOFT channel ID
* \ingroup tsoft
* \ingroup group_tsoft
*/
SFFchannelid translate(const TSOFTchannelid& ci);
/*----------------------------------------------------------------------*/
/*! \brief return channel data for given SFF channel ID
* \ingroup tsoft
* \ingroup group_tsoft
*/
ChannelDescription channel(const SFFchannelid& ci);
......
/*! \file itsoftstream.cc
* \brief actual TSOFT to SFF code (implementation)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -50,7 +50,7 @@ namespace datrw {
//@{
/*! \brief Format properties
* \ingroup tsoft
* \ingroup group_tsoft
*/
const bool tsoft::isbinary=false;
const char* const tsoft::streamID="tsoft";
......@@ -61,7 +61,7 @@ namespace datrw {
namespace tsoft {
//@{
/*! \brief Format modifier keys
* \ingroup tsoft
* \ingroup group_tsoft
*/
const char* const key_keepundetval="keepundetval";
const char* const key_replaceundetval="replaceundetval";
......
/*! \file tsoftconfig.h
* \brief tsoft configuration (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -50,7 +50,7 @@ namespace datrw {
namespace tsoft {
/*! \brief config parameters for data extraction
* \ingroup tsoft
* \ingroup group_tsoft
*
* These parameters control the way gaps in the input data are handled.
*/
......
/*! \file tsoftdata.cc
* \brief class to store TSOFT data (implementation)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......
/*! \file tsoftdata.h
* \brief class to store TSOFT data (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -59,20 +59,20 @@ namespace datrw {
* TSOFT is available from
* http://seismologie.oma.be/TSOFT/tsoft.html
*
* \defgroup tsoft Reading module for: TSOFT data
* \defgroup group_tsoft Reading module for: TSOFT data
*/
/*! \brief All classes and functions to extract data from TSOFT files
*
* \ingroup tsoft
* \ingroup group_tsoft
*/
namespace tsoft {
/*! \brief string constants
*
* \defgroup tsoftconst TSOFT string constants
* \defgroup group_tsoftconst TSOFT string constants
* @{
* \ingroup tsoft
* \ingroup group_tsoft
*/
//! \brief first character of TSOFT tag
extern const char* tagbegin;
......@@ -99,22 +99,22 @@ namespace datrw {
//@}
/*! \brief vector of strings.
*\ingroup tsoft
*\ingroup group_tsoft
*/
typedef std::vector<std::string> Tvos;
/*! \brief list of strings.
*\ingroup tsoft
*\ingroup group_tsoft
*/
typedef std::list<std::string> Tlos;
/*! \brief vector of doubles.
*\ingroup tsoft
*\ingroup group_tsoft
*/
typedef std::vector<double> Tvod;
/*----------------------------------------------------------------------*/
/*! \brief helper function stringtok
* \ingroup tsoft
* \ingroup group_tsoft
*/
Tvos stringtovec(const std::string& line,
const std::string& delimiter=":");
......@@ -122,21 +122,21 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief helper function trimws
* \ingroup tsoft
* \ingroup group_tsoft
*/
void trimws(std::string& line);
/*----------------------------------------------------------------------*/
/*! \brief helper function getDOSline
* \ingroup tsoft
* \ingroup group_tsoft
*/
std::string getDOSline(std::istream& is);
/*----------------------------------------------------------------------*/
/*! \brief contains takes one line and splits it into tag and information.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Line {
public:
......@@ -168,7 +168,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief contains channel info.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Channelinfo {
public:
......@@ -204,14 +204,14 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief vector of channel info.
* \ingroup tsoft
* \ingroup group_tsoft
*/
typedef std::vector<Channelinfo> Tvoci;
/*----------------------------------------------------------------------*/
/*! \brief contains one data line.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Dataline {
public:
......@@ -237,7 +237,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief trace of contiguous data.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Datatrace {
public:
......@@ -265,7 +265,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief sequence of contiguous data.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Datasequence {
public:
......@@ -308,14 +308,14 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief vector of sequences.
* \ingroup tsoft
* \ingroup group_tsoft
*/
typedef std::vector<Datatrace> Tvodt;
/*----------------------------------------------------------------------*/
/*! \brief date for one channel.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Channeldata {
public:
......@@ -366,21 +366,21 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief prepare free comment block from channel info.
* \ingroup tsoft
* \ingroup group_tsoft
*/
Tlos channelinfofree(const Channelinfo& ci);
/*----------------------------------------------------------------------*/
/*! \brief vector of channels.
* \ingroup tsoft
* \ingroup group_tsoft
*/
typedef std::vector<Channeldata> Tvocd;
/*----------------------------------------------------------------------*/
/*! \brief data container.
* \ingroup tsoft
* \ingroup group_tsoft
*/
class Datacontainer {
public:
......
/*! \file tsoftreader.cc
* \brief module to read TSOFT data (implementation)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......
/*! \file tsoftreader.h
* \brief module to read TSOFT data (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -47,14 +47,14 @@ namespace datrw {
namespace tsoft {
/*! \brief string constant to check TSOFT file id
* \ingroup tsoftconst
* \ingroup group_tsoftconst
*/
extern const char* TSOFTID;
/*----------------------------------------------------------------------*/
/*! \brief check list for requiered fields
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct Checklist {
public:
......@@ -81,7 +81,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief read a complete file
* \ingroup tsoft
* \ingroup group_tsoft
*/
class TSOFTfile {
public:
......
/*! \file tsoftsffcontainer.cc
* \brief a container to hold SFF data for one file (implementation)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......
/*! \file tsoftsffcontainer.h
* \brief a container to hold SFF data for one file (prototypes)
* \ingroup tsoft
* \ingroup group_tsoft
*
* ----------------------------------------------------------------------------
*
......@@ -50,7 +50,7 @@ namespace datrw {
namespace tsoft {
/*! \brief contents for one trace of data
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct Trace {
public:
......@@ -70,7 +70,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief contents of a complete TSOFT file
* \ingroup tsoft
* \ingroup group_tsoft
*/
struct File {
//! \brief free comment lines
......@@ -82,7 +82,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief function to read a complete TSOFT file
* \ingroup tsoft
* \ingroup group_tsoft
*/
File readfile(std::istream& is, const ReaderConfig& rc);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment