help() [1/2]

void datrw::itsoftstream::help ( std::ostream &  os = std::cout )

static

Definition at line 154 of file itsoftstream.cc.

References DATRW_report_assert, DATRW_TSOFT_CC_VERSION, DATRW_TSOFT_H_VERSION, datrw::tsoft::key_bridgetime, datrw::tsoft::key_flagbridged, datrw::tsoft::key_keepundetval, datrw::tsoft::key_replaceundetval, datrw::tsoft::reportdatacomments(), datrw::tsoft::reporttranslation(), and datrw::tsoft::translationisunique().

Referenced by datrw::online_help().

  {
    os << std::endl;
    os << "TSOFT data reading functions" << std::endl;
    os << "----------------------------" << std::endl;
    os << DATRW_TSOFT_CC_VERSION << std::endl;
    os << DATRW_TSOFT_H_VERSION << std::endl;
    os << "TSOFT format is defined by the TSOFT software:\n"
      << "  http://seismologie.oma.be/TSOFT/tsoft.html" << std::endl;
    os << "It is the standard data storage format of the UIPC " << std::endl
      << "data acquisition of GWR superconducting gravimeters." << std::endl;
    os << "This reading module is tailored to handle data recorded\n"
      << "for the SG056 at BFO.\n";
    os << std::endl;
    datrw::tsoft::reporttranslation(os);
    os << std::endl;
    datrw::tsoft::reportdatacomments(os);
    DATRW_report_assert(datrw::tsoft::translationisunique(),
                        "TSOFT translation table is not unique");
    os << std::endl;
    os 
      << "The TSOFT reading module supports format modifiers to handle\n"
      << "gaps in the otherwise continuous input data:\n";
    os << "  " << tsoft::key_keepundetval << "\n";
    os 
      << "    Samples of the value defined as \"UNDETVAL\" in the TSOFT\n"
      << "    header are usually regarded as non-existent and for this\n"
      << "    reason produce a gap in the data. If this flag is set,\n"
      << "    these sample values are simply passed to the output.\n";
    os << "  " << tsoft::key_replaceundetval << "=value\n";
    os
      << "    Samples of the value defined as \"UNDETVAL\" in the TSOFT\n"
      << "    header are set to \"value\".\n";
    os << "  " << tsoft::key_bridgetime << "=YYYY/MM/DD/hh/mm/ss\n";
    os
      << "    The UIPC data acquisition system of SG056 occasionally\n"
      << "    produces data lines with unreasonable data times. The\n"
      << "    typical time on these lines is\n"
      << "      0001 01 01 01 01 01\n"
      << "    These entries produce gaps in the output data. If this\n"
      << "    modifier is passed and the line is not the first line\n"
      << "    in the input data line, lines with sample time defined\n"
      << "    by the modifier parameter are replaced by the expected\n"
      << "    time for this line and sample values are included in\n"
      << "    the output data stream.\n";
    os << "  " << tsoft::key_flagbridged << "=value\n";
    os 
      << "    If this flag is set, sample values of lines with originally\n"
      << "    unreasonable sample time being bridge by the reader are\n"
      << "    flagged with sample value being replaced by \"value\".\n";
  } // void itsoftstream::help(std::ostream& os)

Here is the call graph for this function:

Here is the caller graph for this function: