src/GEOM/GEOM_Function.hxx

   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 #ifndef _GEOM_Function_HeaderFile
  24 #define _GEOM_Function_HeaderFile
  25
  26 #ifndef _Standard_TypeMismatch_HeaderFile
  27 #include <Standard_TypeMismatch.hxx>
  28 #endif
  29 #ifndef _Standard_HeaderFile
  30 #include <Standard.hxx>
  31 #endif
  32 #ifndef _Standard_Macro_HeaderFile
  33 #include <Standard_Macro.hxx>
  34 #endif
  35 #ifndef _Handle_MMgt_TShared_HeaderFile
  36 #include <Handle_MMgt_TShared.hxx>
  37 #endif
  38 #ifndef _MMgt_TShared_HeaderFile
  39 #include <MMgt_TShared.hxx>
  40 #endif
  41 #ifndef _Standard_GUID_HeaderFile
  42 #include <Standard_GUID.hxx>
  43 #endif
  44 #ifndef _TopoDS_Shape_HeaderFile
  45 #include <TopoDS_Shape.hxx>
  46 #endif
  47 #ifndef _TDF_Label_HeaderFile
  48 #include <TDF_Label.hxx>
  49 #endif
  50 #ifndef _TDF_LabelSequence_HeaderFile
  51 #include <TDF_LabelSequence.hxx>
  52 #endif
  53 #ifndef _TColStd_HArray1OfExtendedString_HeaderFile
  54 #include <TColStd_HArray1OfExtendedString.hxx>
  55 #endif
  56
  57 class Handle_TColStd_HArray1OfReal;
  58 class Handle_TColStd_HArray1OfInteger;
  59 class Handle_TColStd_HSequenceOfTransient;
  60 class Handle_TColStd_HArray1OfExtendedString;
  61
  62 class Standard_Transient;
  63 class Handle_Standard_Type;
  64 class Handle(MMgt_TShared);
  65 class GEOM_Function;
  66
  67 #include <TCollection_AsciiString.hxx>
  68 #include <TDataStd_ListOfExtendedString.hxx>
  69
  70 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Function);
  71
  72 class Handle(GEOM_Function) : public Handle(MMgt_TShared) {
  73   public:
  74     inline void* operator new(size_t,void* anAddress)
  75       {
  76         return anAddress;
  77       }
  78     inline void* operator new(size_t size)
  79       {
  80         return Standard::Allocate(size);
  81       }
  82     inline void  operator delete(void *anAddress)
  83       {
  84         if (anAddress) Standard::Free((Standard_Address&)anAddress);
  85       }
  86
  87     Handle(GEOM_Function)():Handle(MMgt_TShared)() {}
  88     Handle(GEOM_Function)(const Handle(GEOM_Function)& aHandle) : Handle(MMgt_TShared)(aHandle)
  89      {
  90      }
  91
  92     Handle(GEOM_Function)(const GEOM_Function* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
  93      {
  94      }
  95
  96     Handle(GEOM_Function)& operator=(const Handle(GEOM_Function)& aHandle)
  97      {
  98       Assign(aHandle.Access());
  99       return *this;
 100      }
 101
 102     Handle(GEOM_Function)& operator=(const GEOM_Function* anItem)
 103      {
 104       Assign((Standard_Transient *)anItem);
 105       return *this;
 106      }
 107
 108     GEOM_Function* operator->()
 109      {
 110       return (GEOM_Function *)ControlAccess();
 111      }
 112
 113     GEOM_Function* operator->() const
 114      {
 115       return (GEOM_Function *)ControlAccess();
 116      }
 117
 118    Standard_EXPORT ~Handle(GEOM_Function)() {};
 119
 120    Standard_EXPORT static const Handle(GEOM_Function) DownCast(const Handle(Standard_Transient)& AnObject);
 121 };
 122
 123 class GEOM_Function : public MMgt_TShared
 124 {
 125
 126 public:
 127
 128     inline void* operator new(size_t,void* anAddress)
 129       {
 130         return anAddress;
 131       }
 132     inline void* operator new(size_t size)
 133       {
 134         return Standard::Allocate(size);
 135       }
 136     inline void  operator delete(void *anAddress)
 137       {
 138         if (anAddress) Standard::Free((Standard_Address&)anAddress);
 139       }
 140
 141     // Type management
 142     //
 143     Standard_EXPORT friend Handle_Standard_Type& GEOM_Function_Type_();
 144     Standard_EXPORT const Handle(Standard_Type)& DynamicType() const
 145       { return STANDARD_TYPE(GEOM_Function) ; }
 146     Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)& AType) const
 147       { return (STANDARD_TYPE(GEOM_Function) == AType || MMgt_TShared::IsKind(AType)); }
 148
 149
 150 private:
 151   GEOM_Function(const TDF_Label& theEntry) { _label = theEntry; }
 152
 153 public:
 154
 155   //Returns a GUID for a function tree
 156   Standard_EXPORT static const Standard_GUID& GetFunctionTreeID();
 157
 158   //Returns the ID which is associated with a reference to another function
 159   Standard_EXPORT static const Standard_GUID& GetDependencyID();
 160
 161   //Finds and returns a function located on a label theEntry
 162   Standard_EXPORT static Handle(GEOM_Function) GetFunction(const TDF_Label& theEntry);
 163
 164
 165   Standard_EXPORT GEOM_Function(const TDF_Label& theEntry, const Standard_GUID& theGUID, int theType);
 166   Standard_EXPORT ~GEOM_Function() {;}
 167
 168   Standard_EXPORT TDF_Label GetOwnerEntry();
 169
 170   //Access to properties
 171
 172   //Returns a result of the function built by the function Driver
 173   Standard_EXPORT TopoDS_Shape GetValue();
 174
 175   //Sets the function result
 176   Standard_EXPORT void SetValue(TopoDS_Shape& theShape);
 177
 178   //Returns a function entry in the OCAF document
 179   Standard_EXPORT TDF_Label& GetEntry() { return _label; }
 180
 181   //Returns the type of the function
 182   Standard_EXPORT int GetType();
 183
 184   //Returns a function Driver GUID
 185   Standard_EXPORT Standard_GUID GetDriverGUID();
 186
 187   //Returns aPython description of the function
 188   Standard_EXPORT TCollection_AsciiString GetDescription();
 189
 190   //Sets aPython description of the function
 191   Standard_EXPORT void SetDescription(const TCollection_AsciiString& theDescription);
 192
 193   //Access to arguments
 194
 195   //Sets a real argument at position thePosition
 196   Standard_EXPORT void SetReal(int thePosition, double theValue);
 197
 198   //Returns a real argument at position thePosition
 199   Standard_EXPORT double GetReal(int thePosition);
 200
 201   //Sets a real array argument at position thePosition
 202   Standard_EXPORT void SetRealArray(int thePosition, const Handle(TColStd_HArray1OfReal)& theArray);
 203
 204   //Returns a real array argument at position thePosition
 205   Standard_EXPORT Handle(TColStd_HArray1OfReal) GetRealArray(int thePosition);
 206
 207   //Sets an integer argument at position thePosition
 208   Standard_EXPORT void SetInteger(int thePosition, int theValue);
 209
 210   //Returns an integer argument at position thePosition
 211   Standard_EXPORT int GetInteger(int thePosition);
 212
 213   //Sets an integer array argument at position thePosition
 214   Standard_EXPORT void SetIntegerArray(int thePosition, const Handle(TColStd_HArray1OfInteger)& theArray);
 215
 216   //Returns an integer array argument at position thePosition
 217   Standard_EXPORT Handle(TColStd_HArray1OfInteger) GetIntegerArray(int thePosition);
 218
 219   //Sets a reference to other function argument at position thePosition
 220   Standard_EXPORT void SetReference(int thePosition, Handle(GEOM_Function) theReference);
 221
 222   //Sets a string argument at position thePosition
 223   Standard_EXPORT void SetString(int thePosition, const TCollection_AsciiString& theValue);
 224
 225   //Returns a string argument at position thePosition
 226   Standard_EXPORT TCollection_AsciiString GetString(int thePosition);
 227
 228   //Returns a reference to other function argument at position thePosition
 229   Standard_EXPORT Handle(GEOM_Function) GetReference(int thePosition);
 230
 231   //Set an array of ExtendedString
 232   Standard_EXPORT void SetStringArray(int thePosition, const Handle(TColStd_HArray1OfExtendedString)& theArray);
 233
 234   //Returns the array of ExtendedString
 235   Standard_EXPORT Handle(TColStd_HArray1OfExtendedString) GetStringArray(int thePosition);
 236
 237   //Returns a GUID for a references tree
 238   Standard_EXPORT static const Standard_GUID& GetReferencesTreeID();
 239
 240   //Sets a list of references to other function arguments at position thePosition
 241   Standard_EXPORT void SetReferenceList (int thePosition,
 242                          const Handle(TColStd_HSequenceOfTransient)& theRefList);
 243
 244   //Returns a list of references to other function arguments at position thePosition
 245   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetReferenceList (int thePosition);
 246
 247   //Sets a TopoDS_Shape argument at position thePosition
 248   //void SetShape(int thePosition, const TopoDS_Shape& theShape);
 249
 250   //Returns a TopoDS_Shape argument at position thePosition
 251   //TopoDS_Shape GetShape(int thePosition);
 252
 253   //Returns true if the last method succided
 254   Standard_EXPORT bool IsDone() { return _isDone; }
 255
 256   //Retuns true if this function is the last one in the study
 257   Standard_EXPORT bool IsLastFuntion();
 258
 259   //Returns a sequence of the external dependencies of this function
 260   Standard_EXPORT void GetDependency(TDF_LabelSequence& theSeq);
 261
 262   // Add/Remove/Check/Get subshape references
 263   Standard_EXPORT void AddSubShapeReference   (Handle(GEOM_Function) theSubShape);
 264   Standard_EXPORT void RemoveSubShapeReference(Handle(GEOM_Function) theSubShape);
 265   Standard_EXPORT bool HasSubShapeReferences();
 266   Standard_EXPORT const TDataStd_ListOfExtendedString& GetSubShapeReferences();
 267
 268   //Returns top label of this function's history tree
 269   Standard_EXPORT TDF_Label GetHistoryEntry (const Standard_Boolean create = Standard_True);
 270
 271   //Returns history label, corresponding to the label,
 272   //on which a reference on argument is stored
 273   Standard_EXPORT TDF_Label GetArgumentHistoryEntry (const TDF_Label&       theArgumentRefEntry,
 274                                                      const Standard_Boolean create = Standard_True);
 275
 276   //Returns top label of this function's naming tree
 277   Standard_EXPORT TDF_Label GetNamingEntry (const Standard_Boolean create = Standard_True);
 278
 279 private:
 280
 281   TDF_Label _label;
 282   bool      _isDone;
 283 };
 284
 285 #endif