src/HYDROPy/HYDROData_Entity.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 %ExportedHeaderCode
  24 #include <HYDROData_Entity.h>
  25 %End
  26
  27 typedef int ObjectKind;
  28
  29 const ObjectKind KIND_UNKNOWN;
  30 const ObjectKind KIND_IMAGE;
  31 const ObjectKind KIND_POLYLINE;
  32 const ObjectKind KIND_BATHYMETRY;
  33 const ObjectKind KIND_ALTITUDE;
  34 const ObjectKind KIND_IMMERSIBLE_ZONE;
  35 const ObjectKind KIND_RIVER;
  36 const ObjectKind KIND_STREAM;
  37 const ObjectKind KIND_CONFLUENCE;
  38 const ObjectKind KIND_CHANNEL;
  39 const ObjectKind KIND_OBSTACLE;
  40 const ObjectKind KIND_DIGUE;
  41 const ObjectKind KIND_PROFILE;
  42 const ObjectKind KIND_PROFILEUZ;
  43 const ObjectKind KIND_POLYLINEXY;
  44 const ObjectKind KIND_CALCULATION;
  45 const ObjectKind KIND_ZONE;
  46 const ObjectKind KIND_REGION;
  47
  48 class HYDROData_Entity
  49 {
  50 %TypeHeaderCode
  51 #include <HYDROData_Entity.h>
  52 %End
  53
  54 %ConvertToSubClassCode
  55     // HYDROData_Entity sub-classes provide a unique kind ID.
  56     switch ( sipCpp->GetKind() )
  57     {
  58       case KIND_IMAGE:
  59         sipClass = sipClass_HYDROData_Image;
  60         break;
  61
  62       case KIND_POLYLINEXY:
  63         sipClass = sipClass_HYDROData_PolylineXY;
  64         break;
  65
  66       case KIND_PROFILEUZ:
  67         sipClass = sipClass_HYDROData_ProfileUZ;
  68         break;
  69
  70       case KIND_BATHYMETRY:
  71         sipClass = sipClass_HYDROData_Bathymetry;
  72         break;
  73
  74       case KIND_OBSTACLE_ALTITUDE:
  75         sipClass = sipClass_HYDROData_ObstacleAltitude;
  76         break;
  77
  78       case KIND_IMMERSIBLE_ZONE:
  79         sipClass = sipClass_HYDROData_ImmersibleZone;
  80         break;
  81
  82       case KIND_DIGUE:
  83         sipClass = sipClass_HYDROData_Digue;
  84         break;
  85
  86       case KIND_CHANNEL:
  87         sipClass = sipClass_HYDROData_Channel;
  88         break;
  89
  90       case KIND_CALCULATION:
  91         sipClass = sipClass_HYDROData_CalculationCase;
  92         break;
  93
  94       case KIND_OBSTACLE:
  95         sipClass = sipClass_HYDROData_Obstacle;
  96         break;
  97
  98       case KIND_POLYLINE:
  99         sipClass = sipClass_HYDROData_Polyline3D;
 100         break;
 101
 102       case KIND_PROFILE:
 103         sipClass = sipClass_HYDROData_Profile;
 104         break;
 105
 106       case KIND_REGION:
 107         sipClass = sipClass_HYDROData_Region;
 108         break;
 109
 110       case KIND_STREAM:
 111         sipClass = sipClass_HYDROData_Stream;
 112         break;
 113
 114       case KIND_ZONE:
 115         sipClass = sipClass_HYDROData_Zone;
 116         break;
 117
 118       case KIND_SHAPES_GROUP:
 119         sipClass = sipClass_HYDROData_ShapesGroup;
 120         break;
 121
 122       case KIND_UNKNOWN:
 123         sipClass = sipClass_HYDROData_Entity;
 124         break;
 125
 126       default:
 127         // We don't recognise the type.
 128         sipClass = NULL;
 129     }
 130 %End
 131
 132 public:
 133
 134   /**
 135    * Returns the kind of this object. Must be redefined in all objects of known type.
 136    */
 137   virtual const ObjectKind GetKind() const;
 138
 139   /**
 140    * Returns the name of this object.
 141    */
 142   virtual QString GetName() const;
 143
 144   /**
 145    * Updates the name of this object.
 146    */
 147   virtual void SetName(const QString& theName);
 148
 149   /**
 150    * Updates object state.
 151    */
 152   virtual void Update();
 153
 154   /**
 155    * Returns data of object wrapped to QVariant.
 156    * Base implementation returns null value.
 157    */
 158   virtual QVariant GetDataVariant();
 159
 160
 161   /**
 162    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
 163    * \param theFlag is true for objects that must be updated, false for up-to-date
 164    */
 165   virtual void SetToUpdate( bool theFlag );
 166
 167   /**
 168    * Returns the "MustBeUpdated" flag: is object data must be updated or not
 169    * \returns false if object is up to date
 170    */
 171   virtual bool IsMustBeUpdated() const;
 172
 173   /**
 174    * Returns flag indicating that object is updateble or not.
 175    */
 176   virtual bool CanBeUpdated() const;
 177
 178
 179   /**
 180    * Checks is object exists in the data structure.
 181    * \returns true is object is not exists in the data model
 182    */
 183   bool IsRemoved() const;
 184
 185   /**
 186    * Removes object from the data structure.
 187    */
 188   virtual void Remove();
 189
 190
 191   /**
 192    * Copies all properties of this to the destinated object.
 193    * Objects must be the same type.
 194    * \param theDestination initialized object (from any document) - target of copying
 195    */
 196   void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
 197   %MethodCode
 198     Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
 199     if ( !aCopyTo.IsNull() )
 200     {
 201       Py_BEGIN_ALLOW_THREADS
 202       sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
 203                       sipCpp->CopyTo( aCopyTo );
 204       Py_END_ALLOW_THREADS
 205     }
 206   %End
 207
 208   /**
 209    * Returns father object. For object created under root document label
 210    * this method always return NULL object.
 211    */
 212   HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
 213   %MethodCode
 214     Handle(HYDROData_Entity) aFather;
 215
 216     Py_BEGIN_ALLOW_THREADS
 217     aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
 218                               sipCpp->GetFatherObject();
 219     Py_END_ALLOW_THREADS
 220
 221     sipRes = createPointer( aFather );
 222   %End
 223
 224   /**
 225    * Returns the list of all reference objects of this object.
 226    * Base implementation always return empty list.
 227    */
 228   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 229
 230 protected:
 231
 232   /**
 233    * Creates new object in the internal data structure. Use higher level objects
 234    * to create objects with real content.
 235    */
 236   HYDROData_Entity();
 237
 238   /**
 239    * Destructs properties of the object and object itself, removes it from the document.
 240    */
 241   virtual ~HYDROData_Entity();
 242
 243 };