src/OBJECT/SALOME_InteractiveObject.hxx

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef SALOME_INTERACTIVEOBJECT_HXX
  24 #define SALOME_INTERACTIVEOBJECT_HXX
  25
  26 #include <MMgt_TShared.hxx>
  27 #include <Standard.hxx>
  28 #include <Standard_DefineHandle.hxx>
  29
  30 #include <Basics_OCCTVersion.hxx>
  31
  32 #include <string>
  33
  34 class SALOME_InteractiveObject;
  35 DEFINE_STANDARD_HANDLE(SALOME_InteractiveObject, MMgt_TShared)
  36
  37 class SALOME_InteractiveObject : public MMgt_TShared
  38 {
  39 public:
  40   Standard_EXPORT   SALOME_InteractiveObject();
  41   Standard_EXPORT   SALOME_InteractiveObject(const char* anEntry,
  42                                              const char* aComponentDataType,
  43                                              const char* aName = "");
  44   Standard_EXPORT   virtual ~SALOME_InteractiveObject();
  45
  46   Standard_EXPORT   void setEntry(const char* anEntry);
  47   Standard_EXPORT   const char* getEntry();
  48   Standard_EXPORT   Standard_Boolean hasEntry();
  49
  50   Standard_EXPORT   void setName(const char* aName);
  51   Standard_EXPORT   const char* getName();
  52
  53   Standard_EXPORT   virtual  Standard_Boolean isSame(const Handle(SALOME_InteractiveObject)& anIO);
  54
  55   Standard_EXPORT   void setReference(const char* aReference);
  56   Standard_EXPORT   const char* getReference();
  57   Standard_EXPORT   Standard_Boolean hasReference();
  58
  59   Standard_EXPORT   void setComponentDataType(const char* ComponentDataType);
  60   Standard_EXPORT   const char* getComponentDataType();
  61   Standard_EXPORT   Standard_Boolean isComponentType(const char* ComponentDataType);
  62
  63   // Must be defined for using by NCollection for ceratin of data map
  64   Standard_EXPORT friend Standard_Boolean IsEqual(const Handle(SALOME_InteractiveObject)& anIO1,
  65                                   const Handle(SALOME_InteractiveObject)& anIO2);
  66
  67 protected:
  68   std::string myEntry;
  69   std::string myName;
  70   std::string myComponentDataType;
  71   std::string myReference;
  72
  73 public:
  74   OCCT_DEFINE_STANDARD_RTTIEXT(SALOME_InteractiveObject,MMgt_TShared)
  75 };
  76
  77 #endif // SALOME_INTERACTIVEOBJECT_HXX