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