help() [1/2]

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

static

Definition at line 72 of file osustream.cc.

References datrw::su::subformat::key::coodigits, datrw::su::subformat::def::coodigits, DATRW_OSUSTREAM_CC_VERSION, datrw::su::subformat::key::forceseismic, datrw::su::subformat::key::forceultrasonic, datrw::su::SUheader::help(), datrw::su::subformat::key::scalco, and datrw::su::subformat::def::scalco.

Referenced by datrw::online_help().

  {
    os <<
      std::endl <<
      "SeismicUn*x writing functions" << std::endl <<
      "-----------------------------" << std::endl <<
      DATRW_OSUSTREAM_CC_VERSION << std::endl <<
      std::endl <<
      "This module provides writing of SeismicUn*x binary data files."
      << std::endl;
    os << std::endl;
    datrw::su::SUheader::help(os);
    os << std::endl;
    os <<
      "Valid format modifiers are:\n";
    formatmodifiers::ModifierHelp mh(os, 14);    
    mh(su::subformat::key::forceultrasonic) <<
              "Force writing of ultrasonic data header\n";
      mh() << "The default is to write standard SeismicUn*x\n";
      mh() << "headers for seismic sampling intervals.\n";
    mh(su::subformat::key::forceseismic) <<
              "Force writing of seismic data header even\n";
      mh() << "is sampling interval is too small.\n";
      mh() << "Choosing both modifiers at once is an\n";
      mh() << "inconsistency and causes abort().\n";
    mh(su::subformat::key::scalco, "s") <<
              "\"s\" is used as the preferred scalco and scalel value.\n";
      mh() << "It is used only if it does not cause round-off truncation.\n";
      mh() << "The default is " 
           << su::subformat::key::scalco << "=" 
           << datrw::su::subformat::def::scalco << "\n";
    mh(su::subformat::key::coodigits, "n") <<
              "Limits the maximum number of significant digits in\n";
      mh() << "spatial coordinates to \"n\". Coordinate values with\n";
      mh() << "more digits will be truncated.\n";
      mh() << "The default is " 
           << su::subformat::key::coodigits << "=" 
           << datrw::su::subformat::def::coodigits << "\n";
  } // void osustream::help(std::ostream& os=std::cout)

Here is the call graph for this function:

Here is the caller graph for this function: