include/opencascade/TFunction_Function.hxx

0001 // Created on: 1999-06-10
0002 // Created by: Vladislav ROMASHKO
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TFunction_Function_HeaderFile
0018 #define _TFunction_Function_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_GUID.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <TDF_Attribute.hxx>
0026 #include <Standard_OStream.hxx>
0027 class TDF_Label;
0028 class TDF_RelocationTable;
0029 class TDF_DataSet;
0030
0031 //! Provides the following two services
0032 //! -   a link to an evaluation driver
0033 //! -   the means of providing a link between a
0034 //! function and an evaluation driver.
0035 class TFunction_Function : public TDF_Attribute
0036 {
0037
0038 public:
0039   //! Static methods:
0040   //! ==============
0041   //! Finds or Creates a function attribute on the label <L>.
0042   //! Returns the function attribute.
0043   Standard_EXPORT static occ::handle<TFunction_Function> Set(const TDF_Label& L);
0044
0045   //! Finds or Creates a function attribute on the label <L>.
0046   //! Sets a driver ID to the function.
0047   //! Returns the function attribute.
0048   Standard_EXPORT static occ::handle<TFunction_Function> Set(const TDF_Label&     L,
0049                                                              const Standard_GUID& DriverID);
0050
0051   //! Returns the GUID for functions.
0052   //! Returns a function found on the label.
0053   //! Instance methods:
0054   //! ================
0055   Standard_EXPORT static const Standard_GUID& GetID();
0056
0057   Standard_EXPORT TFunction_Function();
0058
0059   //! Returns the GUID for this function's driver.
0060   const Standard_GUID& GetDriverGUID() const { return myDriverGUID; }
0061
0062   //! Sets the driver for this function as that
0063   //! identified by the GUID guid.
0064   Standard_EXPORT void SetDriverGUID(const Standard_GUID& guid);
0065
0066   //! Returns true if the execution failed
0067   bool Failed() const { return myFailure != 0; }
0068
0069   //! Sets the failed index.
0070   Standard_EXPORT void SetFailure(const int mode = 0);
0071
0072   //! Returns an index of failure if the execution of this function failed.
0073   //! If this integer value is 0, no failure has occurred.
0074   //! Implementation of Attribute methods:
0075   //! ===================================
0076   int GetFailure() const { return myFailure; }
0077
0078   Standard_EXPORT const Standard_GUID& ID() const override;
0079
0080   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& with) override;
0081
0082   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       into,
0083                              const occ::handle<TDF_RelocationTable>& RT) const override;
0084
0085   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0086
0087   Standard_EXPORT void References(const occ::handle<TDF_DataSet>& aDataSet) const override;
0088
0089   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0090
0091   //! Dumps the content of me into the stream
0092   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0093
0094   DEFINE_STANDARD_RTTIEXT(TFunction_Function, TDF_Attribute)
0095
0096 private:
0097   Standard_GUID myDriverGUID;
0098   int           myFailure;
0099 };
0100
0101 #endif // _TFunction_Function_HeaderFile