src/HYDROPy/HYDROData_Object.sip

   1 // Copyright (C) 2007-2013  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.
  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
  24 %ExportedHeaderCode
  25 #include <HYDROData_Object.h>
  26 %End
  27
  28 typedef int ObjectKind;
  29
  30 class HYDROData_Object
  31 {
  32 %TypeHeaderCode
  33 #include <HYDROData_Object.h>
  34 %End
  35
  36 %ConvertToSubClassCode
  37     // HYDROData_Object sub-classes provide a unique kind ID.
  38     switch ( sipCpp->GetKind() )
  39     {
  40       case KIND_IMAGE:
  41         sipClass = sipClass_HYDROData_Image;
  42         break;
  43
  44       case KIND_POLYLINE:
  45         sipClass = sipClass_HYDROData_Polyline;
  46         break;
  47
  48       case KIND_BATHYMETRY:
  49         sipClass = sipClass_HYDROData_Bathymetry;
  50         break;
  51
  52       case KIND_UNKNOWN:
  53         sipClass = sipClass_HYDROData_Object;
  54         break;
  55
  56       default:
  57         // We don't recognise the type.
  58         sipClass = NULL;
  59     }
  60 %End
  61
  62 public:
  63
  64   /**
  65    * Returns the kind of this object. Must be redefined in all objects of known type.
  66    */
  67   const ObjectKind GetKind() const;
  68
  69   /**
  70    * Returns the name of this object.
  71    */
  72   QString GetName() const;
  73
  74   /**
  75    * Updates the name of this object.
  76    */
  77   void SetName(const QString& theName);
  78
  79   /**
  80    * Updates object state.
  81    */
  82   void Update();
  83
  84   /**
  85    * Checks is object exists in the data structure.
  86    * \returns true is object is not exists in the data model
  87    */
  88   bool IsRemoved() const;
  89
  90   /**
  91    * Removes object from the data structure.
  92    */
  93   void Remove();
  94
  95   /**
  96    * Returns unique integer identifier of the object (may be used for ordering of objects)
  97    */
  98   int ID() const;
  99
 100   /**
 101    * Copies all properties of this to the destinated object.
 102    * Objects must be the same type.
 103    * \param theDestination initialized object (from any document) - target of copying
 104    */
 105   /*
 106   void CopyTo( HYDROData_Object theDestination ) const;
 107   */
 108
 109 protected:
 110
 111   /**
 112    * Creates new object in the internal data structure. Use higher level objects
 113    * to create objects with real content.
 114    */
 115   HYDROData_Object();
 116
 117   /**
 118    * Destructs properties of the object and object itself, removes it from the document.
 119    */
 120   virtual ~HYDROData_Object();
 121
 122 };