src/ICoCo/ICoCoMEDDoubleField.hxx

   1 // Copyright (C) 2007-2021  CEA/DEN, EDF R&D
   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 // WARNING: this file is part of the official ICoCo API and should not be modified.
  21 // The official version can be found at the following URL:
  22 //
  23 //    https://github.com/cea-trust-platform/icoco-coupling
  24
  25 #ifndef ICoCoMEDDoubleField_included
  26 #define ICoCoMEDDoubleField_included
  27
  28 #include "ICoCoField.hxx"
  29 #include "ICoCo.hxx"
  30
  31 namespace MEDCoupling
  32 {
  33   class MEDCouplingFieldDouble;
  34 }
  35
  36 namespace ICoCo
  37 {
  38   /*! @brief Field data stored internally as a MEDCoupling object.
  39    *
  40    * This class is a wrapper around a MEDCoupling::MEDCouplingFieldDouble object, which holds the field data.
  41    * In version 2 of ICoCo, MEDCoupling::MEDCouplingFieldDouble objects are not anymore exposed directly into the API
  42    * of ICoCo::Problem. The rationale is to make the interface ICoCo::Problem free of external dependencies
  43    * (MEDCoupling particularly).
  44    *
  45    * @sa the MEDCoupling documentation, notably the reference counter mechanism used to manage the lifecycle of
  46    * MEDCoupling objects.
  47    */
  48 #ifndef SWIG
  49   class MEDCOUPLINGICOCO_EXPORT MEDDoubleField : public ICoCo::Field
  50 #else
  51   class MEDDoubleField : public ICoCo::Field
  52 #endif
  53   {
  54   public:
  55     /*! Builds an empty field (internal MEDCoupling object not set).
  56      */
  57     MEDDoubleField();
  58
  59     /*! @brief Builds a field and assign its internal MEDCouplingField object.
  60      *
  61      * The name of 'this' is also automatically set the name of the MEDCouplingField object. If 'field' is null
  62      * the name is set to the empty string.
  63      *
  64      * @param field MEDCoupling field instance to use for field data. The field reference counter is incremented.
  65      */
  66     MEDDoubleField(MEDCoupling::MEDCouplingFieldDouble* field);
  67
  68     /*! @brief Copy construcotr.
  69      */
  70     MEDDoubleField(const MEDDoubleField& field);
  71
  72     /*! @brief Assignement operator.
  73      * @param field another MEDDoubleField instance. The previous internal MEDCoupling field reference (if any) has
  74      * its counter decremented.
  75      */
  76     MEDDoubleField& operator=(const MEDDoubleField& field);
  77
  78     /*! @brief Destructor.
  79      */
  80     virtual ~MEDDoubleField();
  81
  82     /*! @brief Get the internal MEDCoupling field object.
  83      * @return a pointer to the MEDCouplingField object detained by this instance. Note that the corresponding
  84      * object should not be deleted, or its reference counter should not be decreased! Doing so will result in an
  85      * invalid instance of the current MEDField.
  86      */
  87     MEDCoupling::MEDCouplingFieldDouble *getMCField() const;
  88
  89     /*! @brief Set the internal MEDCoupling field object.
  90      *
  91      * Any previously set field is discarded (its reference counter is decreased) and the reference counter of the
  92      * field being set is increased.
  93      *
  94      * The name of 'this' is also automatically set the name of the MEDCouplingField object. If 'field' is nullptr
  95      * the name is reset to the empty string.
  96      *
  97      * @param field MEDCouplingFieldDouble object to be used.
  98      */
  99     void setMCField(MEDCoupling::MEDCouplingFieldDouble * field);
 100
 101   private:
 102     MEDCoupling::MEDCouplingFieldDouble *_field;
 103   };
 104 } // namespace ICoCo
 105
 106 #endif