include/opencascade/Interface_HGraph.hxx

0001 // Created on: 1993-04-22
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-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 _Interface_HGraph_HeaderFile
0018 #define _Interface_HGraph_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Interface_Graph.hxx>
0024 #include <Standard_Transient.hxx>
0025 class Interface_InterfaceModel;
0026 class Interface_GeneralLib;
0027 class Interface_Protocol;
0028 class Interface_GTool;
0029
0030
0031 class Interface_HGraph;
0032 DEFINE_STANDARD_HANDLE(Interface_HGraph, Standard_Transient)
0033
0034 //! This class allows to store a redefinable Graph, via a Handle
0035 //! (useful for an Object which can work on several successive
0036 //! Models, with the same general conditions)
0037 class Interface_HGraph : public Standard_Transient
0038 {
0039
0040 public:
0041
0042
0043   //! Creates an HGraph directly from a Graph.
0044   //! Remark that the starting Graph is duplicated
0045   Standard_EXPORT Interface_HGraph(const Interface_Graph& agraph);
0046
0047   //! Creates an HGraph with a Graph created from <amodel> and <lib>
0048   Standard_EXPORT Interface_HGraph(const Handle(Interface_InterfaceModel)& amodel, const Interface_GeneralLib& lib, const Standard_Boolean theModeStats = Standard_True);
0049
0050   //! Creates an HGraph with a graph itself created from <amodel>
0051   //! and <protocol>
0052   Standard_EXPORT Interface_HGraph(const Handle(Interface_InterfaceModel)& amodel, const Handle(Interface_Protocol)& protocol, const Standard_Boolean theModeStats = Standard_True);
0053
0054   //! Creates an HGraph with a graph itself created from <amodel>
0055   //! and <protocol>
0056   Standard_EXPORT Interface_HGraph(const Handle(Interface_InterfaceModel)& amodel, const Handle(Interface_GTool)& gtool, const Standard_Boolean theModeStats = Standard_True);
0057
0058   //! Same a above, but works with the GTool in the model
0059   Standard_EXPORT Interface_HGraph(const Handle(Interface_InterfaceModel)& amodel, const Standard_Boolean theModeStats = Standard_True);
0060
0061   //! Returns the Graph contained in <me>, for Read Only Operations
0062   //! Remark that it is returns as "const &"
0063   //! Getting it in a new variable instead of a reference would be
0064   //! a pity, because all the graph's content would be duplicated
0065   Standard_EXPORT const Interface_Graph& Graph() const;
0066
0067   //! Same as above, but for Read-Write Operations
0068   //! Then, The Graph will be modified in the HGraph itself
0069   Standard_EXPORT Interface_Graph& CGraph();
0070
0071
0072
0073
0074   DEFINE_STANDARD_RTTIEXT(Interface_HGraph,Standard_Transient)
0075
0076 protected:
0077
0078
0079
0080
0081 private:
0082
0083
0084   Interface_Graph thegraph;
0085
0086
0087 };
0088
0089
0090
0091
0092
0093
0094
0095 #endif // _Interface_HGraph_HeaderFile