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
0032 class TFunction_Function;
0033 DEFINE_STANDARD_HANDLE(TFunction_Function, TDF_Attribute)
0034
0035 //! Provides the following two services
0036 //! -   a link to an evaluation driver
0037 //! -   the means of providing a link between a
0038 //! function and an evaluation driver.
0039 class TFunction_Function : public TDF_Attribute
0040 {
0041
0042 public:
0043
0044
0045   //! Static methods:
0046   //! ==============
0047   //! Finds or Creates a function attribute on the label <L>.
0048   //! Returns the function attribute.
0049   Standard_EXPORT static Handle(TFunction_Function) Set (const TDF_Label& L);
0050
0051   //! Finds or Creates a function attribute on the label <L>.
0052   //! Sets a driver ID to the function.
0053   //! Returns the function attribute.
0054   Standard_EXPORT static Handle(TFunction_Function) Set (const TDF_Label& L, const Standard_GUID& DriverID);
0055
0056   //! Returns the GUID for functions.
0057   //! Returns a function found on the label.
0058   //! Instance methods:
0059   //! ================
0060   Standard_EXPORT static const Standard_GUID& GetID();
0061
0062   Standard_EXPORT TFunction_Function();
0063
0064   //! Returns the GUID for this function's driver.
0065   const Standard_GUID& GetDriverGUID() const { return myDriverGUID; }
0066
0067   //! Sets the driver for this function as that
0068   //! identified by the GUID guid.
0069   Standard_EXPORT void SetDriverGUID (const Standard_GUID& guid);
0070
0071   //! Returns true if the execution failed
0072   Standard_Boolean Failed() const { return myFailure != 0; }
0073
0074   //! Sets the failed index.
0075   Standard_EXPORT void SetFailure (const Standard_Integer mode = 0);
0076
0077   //! Returns an index of failure if the execution of this function failed.
0078   //! If this integer value is 0, no failure has occurred.
0079   //! Implementation of Attribute methods:
0080   //! ===================================
0081   Standard_Integer GetFailure() const { return myFailure; }
0082
0083   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0084
0085   Standard_EXPORT virtual void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0086
0087   Standard_EXPORT virtual void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0088
0089   Standard_EXPORT virtual Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0090
0091   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& aDataSet) const Standard_OVERRIDE;
0092
0093   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0094
0095   //! Dumps the content of me into the stream
0096   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0097
0098   DEFINE_STANDARD_RTTIEXT(TFunction_Function,TDF_Attribute)
0099
0100 private:
0101
0102   Standard_GUID myDriverGUID;
0103   Standard_Integer myFailure;
0104
0105 };
0106
0107 #endif // _TFunction_Function_HeaderFile