include/opencascade/TFunction_GraphNode.hxx

0001 // Created on: 2008-06-21
0002 // Created by: Vladislav ROMASHKO
0003 // Copyright (c) 2008-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TFunction_GraphNode_HeaderFile
0017 #define _TFunction_GraphNode_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <TColStd_MapOfInteger.hxx>
0023 #include <TFunction_ExecutionStatus.hxx>
0024 #include <TDF_Attribute.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <Standard_OStream.hxx>
0027 class TDF_Label;
0028 class Standard_GUID;
0029 class TDF_RelocationTable;
0030 class TDF_DataSet;
0031
0032
0033 class TFunction_GraphNode;
0034 DEFINE_STANDARD_HANDLE(TFunction_GraphNode, TDF_Attribute)
0035
0036 //! Provides links between functions.
0037 class TFunction_GraphNode : public TDF_Attribute
0038 {
0039
0040 public:
0041
0042
0043   //! Static methods
0044   //! ==============
0045   //! Finds or Creates a graph node attribute at the label <L>.
0046   //! Returns the attribute.
0047   Standard_EXPORT static Handle(TFunction_GraphNode) Set (const TDF_Label& L);
0048
0049   //! Returns the GUID for GraphNode attribute.
0050   //! Instant methods
0051   //! ===============
0052   //! Constructor (empty).
0053   Standard_EXPORT static const Standard_GUID& GetID();
0054
0055   Standard_EXPORT TFunction_GraphNode();
0056
0057   //! Defines a reference to the function as a previous one.
0058   Standard_EXPORT Standard_Boolean AddPrevious (const Standard_Integer funcID);
0059
0060   //! Defines a reference to the function as a previous one.
0061   Standard_EXPORT Standard_Boolean AddPrevious (const TDF_Label& func);
0062
0063   //! Removes a reference to the function as a previous one.
0064   Standard_EXPORT Standard_Boolean RemovePrevious (const Standard_Integer funcID);
0065
0066   //! Removes a reference to the function as a previous one.
0067   Standard_EXPORT Standard_Boolean RemovePrevious (const TDF_Label& func);
0068
0069   //! Returns a map of previous functions.
0070   Standard_EXPORT const TColStd_MapOfInteger& GetPrevious() const;
0071
0072   //! Clears a map of previous functions.
0073   Standard_EXPORT void RemoveAllPrevious();
0074
0075   //! Defines a reference to the function as a next one.
0076   Standard_EXPORT Standard_Boolean AddNext (const Standard_Integer funcID);
0077
0078   //! Defines a reference to the function as a next one.
0079   Standard_EXPORT Standard_Boolean AddNext (const TDF_Label& func);
0080
0081   //! Removes a reference to the function as a next one.
0082   Standard_EXPORT Standard_Boolean RemoveNext (const Standard_Integer funcID);
0083
0084   //! Removes a reference to the function as a next one.
0085   Standard_EXPORT Standard_Boolean RemoveNext (const TDF_Label& func);
0086
0087   //! Returns a map of next functions.
0088   Standard_EXPORT const TColStd_MapOfInteger& GetNext() const;
0089
0090   //! Clears a map of next functions.
0091   Standard_EXPORT void RemoveAllNext();
0092
0093   //! Returns the execution status of the function.
0094   Standard_EXPORT TFunction_ExecutionStatus GetStatus() const;
0095
0096   //! Defines an execution status for a function.
0097   //! Implementation of Attribute methods
0098   //! ===================================
0099   Standard_EXPORT void SetStatus (const TFunction_ExecutionStatus status);
0100
0101   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0102
0103   Standard_EXPORT virtual void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0104
0105   Standard_EXPORT virtual void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0106
0107   Standard_EXPORT virtual Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0108
0109   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& aDataSet) const Standard_OVERRIDE;
0110
0111   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0112
0113
0114
0115
0116   DEFINE_STANDARD_RTTIEXT(TFunction_GraphNode,TDF_Attribute)
0117
0118 protected:
0119
0120
0121
0122
0123 private:
0124
0125
0126   TColStd_MapOfInteger myPrevious;
0127   TColStd_MapOfInteger myNext;
0128   TFunction_ExecutionStatus myStatus;
0129
0130
0131 };
0132
0133
0134
0135
0136
0137
0138
0139 #endif // _TFunction_GraphNode_HeaderFile