help() [1/2]

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

static

Definition at line 135 of file obinarystream.cc.

References DATRW_OBINARYSTREAM_CC_VERSION.

Referenced by datrw::online_help().

  { 
    os <<
      std::endl <<
      "BINARY writing functions" << std::endl <<
      "------------------------" << std::endl <<
      DATRW_OBINARYSTREAM_CC_VERSION << std::endl <<
      std::endl;
    os << 
      "This module writes data in its simple binary representaion.\n"
      "It is provided primarily for input/output efficiency. This format\n"
      "does not require any output or input formatting. It also does not\n"
      "require conversion of sample values. For this reason no round-off\n"
      "will take place, not for the sample values and not for the sampling\n"
      "interval. The format maps memory content to file and is lossless\n"
      "for this reason. The file is identified by a magic number. This\n"
      "allows the input module to perform automatic on-the-fly\n"
      "byte-swapping if required by the CPU type in use.\n"
      << std::endl;
  } // void obinarystream::help(std::ostream& os)

Here is the caller graph for this function: