doc/doxygen/fakesources/MEDFileField.C

   1 // Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // This file contains some code used only for
  21 // generation of documentation for inline methods.
  22
  23
  24 namespace ParaMEDMEM // inline methods of MEDFileField1TSWithoutSDA
  25 {
  26   /*!
  27    * Returns the number of iteration where \a this field has been calculated.
  28    *  \return int - the iteration number.
  29    */
  30   int MEDFileField1TSWithoutSDA::getIteration() const {}
  31   /*!
  32    * Returns the order number of iteration where \a this field has been calculated.
  33    *  \return int - the order number.
  34    */
  35   int MEDFileField1TSWithoutSDA::getOrder() const {}
  36   /*!
  37    * Returns time, number of iteration and order number of iteration when
  38    * \a this field has been calculated.
  39    *  \param [out] iteration - the iteration number.
  40    *  \param [out] order - the order number.
  41    *  \return double - the time value.
  42    */
  43   double MEDFileField1TSWithoutSDA::getTime(int& iteration, int& order) const {}
  44   /*!
  45    * Sets time, number of iteration and order number of iteration when
  46    * \a this field has been calculated.
  47    *  \param [in] val - the time value.
  48    *  \param [in] iteration - the iteration number.
  49    *  \param [in] order - the order number.
  50    */
  51   void MEDFileField1TSWithoutSDA::setTime(int iteration, int order, double val) {}
  52   /*!
  53    * Returns units in which the time is measured.
  54    *  \return const char * - the time unit name.
  55    */
  56   const std::string& MEDFileField1TSWithoutSDA::getDtUnit() const {}
  57 }
  58
  59 namespace ParaMEDMEM // inline methods of MEDFileFieldGlobsReal
  60 {
  61   /*!
  62    * Returns non empty names of all used profiles. To get all profiles call getPfls().
  63    *  \warning If a profile is used several times, its name is returned **only once**.
  64    *           To have a profile name in the result each time it is used, call
  65    *           getPflsReallyUsedMulti().
  66    *  \return std::vector<std::string> - a sequence of names of used profiles.
  67    */
  68   std::vector<std::string> MEDFileFieldGlobsReal::getPflsReallyUsed() const {}
  69   /*!
  70    * Returns non empty names of all used localizations. To get all localizations call getLocs().
  71    *  \warning If a localization is used several times, its name is returned **only once**.
  72    *           To have a localization name in the result each time it is used, call
  73    *           getLocsReallyUsedMulti().
  74    *  \return std::vector<std::string> - a sequence of names of used localizations.
  75    */
  76   std::vector<std::string> MEDFileFieldGlobsReal::getLocsReallyUsed() const {}
  77   /*!
  78    * Returns non empty names of all used profiles as many times as they are used.
  79    *  \return std::vector<std::string> - a sequence of names of used profiles.
  80    */
  81   std::vector<std::string> MEDFileFieldGlobsReal::getPflsReallyUsedMulti() const {}
  82   /*!
  83    * Returns non empty names of all used localizations as many times as they are used.
  84    *  \return std::vector<std::string> - a sequence of names of used localizations.
  85    */
  86   std::vector<std::string> MEDFileFieldGlobsReal::getLocsReallyUsedMulti() const {}
  87   /*!
  88    * Replaces references to some profiles (a reference is a profile name) by references
  89    * to other profiles.
  90    * \param [in] mapOfModif - a sequence describing required replacements. Each element of
  91    *        this sequence is a pair whose
  92    *        - the first item is a vector of profile names to replace by the second item,
  93    *        - the second item is a profile name to replace every profile of the first item.
  94    */
  95   void MEDFileFieldGlobsReal::changePflsRefsNamesGen(const std::vector< std::pair<std::vector<std::string>, std::string > >& mapOfModif) throw(INTERP_KERNEL::Exception) {}
  96   /*!
  97    * Replaces references to some localizations (a reference is a localization name) by references
  98    * to other localizations.
  99    * \param [in] mapOfModif - a sequence describing required replacements. Each element of
 100    *        this sequence is a pair whose
 101    *        - the first item is a vector of localization names to replace by the second item,
 102    *        - the second item is a localization name to replace every localization of the first
 103    *          item.
 104    */
 105   void MEDFileFieldGlobsReal::changeLocsRefsNamesGen(const std::vector< std::pair<std::vector<std::string>, std::string > >& mapOfModif) throw(INTERP_KERNEL::Exception) {}
 106 }