include/opencascade/Interface_GraphContent.hxx

0001 // Created on: 1992-09-23
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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_GraphContent_HeaderFile
0018 #define _Interface_GraphContent_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Interface_EntityIterator.hxx>
0025 #include <Standard_Integer.hxx>
0026 class Interface_Graph;
0027 class Standard_Transient;
0028
0029 //! Defines general form for classes of graph algorithms on
0030 //! Interfaces, this form is that of EntityIterator
0031 //! Each sub-class fills it according to its own algorithm
0032 //! This also allows to combine any graph result to others,
0033 //! all being given under one unique form
0034 class Interface_GraphContent : public Interface_EntityIterator
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   //! Creates an empty GraphContent, ready to be filled
0040   Standard_EXPORT Interface_GraphContent();
0041
0042   //! Creates with all entities designated by a Graph
0043   Standard_EXPORT Interface_GraphContent(const Interface_Graph& agraph);
0044
0045   //! Creates with entities having specific Status value in a Graph
0046   Standard_EXPORT Interface_GraphContent(const Interface_Graph& agraph, const int stat);
0047
0048   //! Creates an Iterator with Shared entities of an entity
0049   //! (equivalente to EntityIterator but with a Graph)
0050   Standard_EXPORT Interface_GraphContent(const Interface_Graph&                 agraph,
0051                                          const occ::handle<Standard_Transient>& ent);
0052
0053   //! Gets all Entities designated by a Graph (once created), adds
0054   //! them to those already recorded
0055   Standard_EXPORT void GetFromGraph(const Interface_Graph& agraph);
0056
0057   //! Gets entities from a graph which have a specific Status value
0058   //! (one created), adds them to those already recorded
0059   Standard_EXPORT void GetFromGraph(const Interface_Graph& agraph, const int stat);
0060
0061   //! Returns Result under the exact form of an EntityIterator :
0062   //! Can be used when EntityIterator itself is required (as a
0063   //! returned value for instance), without way for a sub-class
0064   Standard_EXPORT Interface_EntityIterator Result();
0065
0066   //! Does the Evaluation before starting the iteration itself
0067   //! (in out)
0068   Standard_EXPORT void Begin();
0069
0070   //! Evaluates list of Entities to be iterated. Called by Start
0071   //! Default is set to doing nothing : intended to be redefined
0072   //! by each sub-class
0073   Standard_EXPORT virtual void Evaluate();
0074 };
0075
0076 #endif // _Interface_GraphContent_HeaderFile