src/engine/Port.hxx

   1 // Copyright (C) 2006-2020  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 #ifndef __PORT_HXX__
  21 #define __PORT_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24
  25 #include <string>
  26
  27 namespace YACS
  28 {
  29   namespace ENGINE
  30   {
  31     class Node;
  32
  33 /*! \brief Base class for all ports
  34  *
  35  * Not instanciable class that factorizes all basic data and behaviours relative
  36  * to the in and out interfaces of all nodes.
  37  * End-user should neither instanciate a sub-class of 'Port'
  38  * nor call other methods than accessor.
  39  *
  40  * \ingroup Ports
  41  */
  42     class YACSLIBENGINE_EXPORT Port
  43     {
  44     public:
  45       virtual ~Port();
  46       Node *getNode() const { return _node; }
  47       virtual std::string getNameOfTypeOfCurrentInstance() const;
  48       int getNumId() const { return _id; }
  49       virtual std::string typeName() {return "YACS__ENGINE__Port";}
  50       void modified();
  51     protected:
  52       Port(Node *node);
  53       Port(const Port& other, Node *newHelder);
  54     protected:
  55       Node        *_node;
  56       int          _id;
  57       static int   _total;
  58       static const char NAME[];
  59     };
  60   }
  61 }
  62
  63 #endif