From: cvs Date: Thu, 7 Oct 1999 16:31:54 +0000 (+0000) Subject: Doc update. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8e6306a241bc256d0dd9dadde211b256c8438f49;p=dealii-svn.git Doc update. git-svn-id: https://svn.dealii.org/trunk@1749 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index 79718a8539..02c0f2e15f 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -910,6 +910,48 @@ class DataOutBase * its member classes. * * + * \section{Run time selection of output parameters} + * + * In the output flags classes, described above, many flags are + * defined for output in the different formats. In order to make them + * available to the input file handler class #ParameterHandler#, each + * of these has a function declaring these flags to the parameter + * handler and to read them back from an actual input file. In order + * to avoid that in user programs these functions have to be called + * for each available output format and the respective flag class, the + * present #DataOut_Interface# class offers a function + * #declare_parameters# which calls the respective function of all + * known output format flags classes. The flags of each such format + * are packed together in a subsection in the input file. + * Likewise, there is a function #parse_parameters# which reads + * these parameters and stores them in the flags associated with + * this object (see above). + * + * Using these functions, you do not have to track which formats are + * presently implemented. + * + * Usage is as follows: + * \begin{verbatim} + * // within function declaring parameters: + * ... + * prm.enter_subsection ("Output format options"); + * DataOutInterface::declare_parameters (prm); + * prm.leave_subsection (); + * ... + * + * + * // within function doing the output: + * ... + * DataOut out; + * prm.enter_subsection ("Output format options"); + * out.parse_parameters (prm); + * prm.leave_subsection (); + * ... + * \end{verbatim} + * Note that in the present example, the class #DataOut# was used. However, any + * other class derived from #DataOut_Interface# would work alike. + * + * * \subsection{Run time selection of formats} * * This class, much like the #GridOut# class, has a set of functions @@ -927,6 +969,7 @@ class DataOutBase * the formats presently implemented. User programs need therefore not * be changed whenever a new format is implemented. * + * * @author Wolfgang Bangerth, 1999 */ template