src/ICoCo/ICoCoField.hxx

   1 // Copyright (C) 2007-2023  CEA, EDF
   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 ICoCoField_included
  26 #define ICoCoField_included
  27 #include <string>
  28
  29 #include <ICoCo_DeclSpec.hxx>
  30
  31 namespace ICoCo
  32 {
  33   /*! @brief Top abstract class defining field objects that can be exchanged via the ICoCo interface.
  34    *
  35    * The Field class holds the name of the field.
  36    */
  37   class ICOCO_EXPORT Field
  38   {
  39   public:
  40     /*! @brief Set the name of the field.
  41      * @param name name of the field
  42      */
  43     void setName(const std::string& name);
  44
  45     /*! @brief Retrieves the name of the field.
  46      * @return name of the field.
  47      */
  48     const std::string& getName() const;
  49
  50     /*!
  51      * @brief Retrieves the name of the field as a char *
  52      * @return name of the field.
  53      */
  54     const char* getCharName() const;
  55
  56   protected:
  57     Field();
  58     virtual ~Field();
  59
  60   private:
  61     std::string* _name;
  62   };
  63 } // namespace ICoCo
  64 #endif