outputpage.h 1021 B

12345678910111213141516171819202122
  1. /** \page output_page Output modules - generating output files with model results
  2. LPJ-GUESS is distributed with an output module for many common outputs (CommonOutput),
  3. but the user may need to supply code for additional outputs. This can be done either
  4. by modifying the standard output module, or by creating a new output module.
  5. All output modules inherit from the base class OutputModule.
  6. Most output related code is gathered in the namespace GuessOutput.
  7. - \ref GuessOutput::CommonOutput
  8. - \ref GuessOutput::MiscOutput
  9. - \ref GuessOutput::OutputModule
  10. - \ref REGISTER_OUTPUT_MODULE - A macro for registering a new output module
  11. The output modules typically generate text output. They should however not create these
  12. text files directly, but rather use convenience classes. All output should go through a
  13. so called output channel. The output channel will take care of generating the correct file
  14. format, and for instance align columns etc.
  15. The output channel related classes are defined in outputchannel.h.
  16. */