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