include/opencascade/Interface_ShareFlags.hxx

0001 // Created on: 1993-04-05
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_ShareFlags_HeaderFile
0018 #define _Interface_ShareFlags_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Interface_BitMap.hxx>
0025 #include <TColStd_HSequenceOfTransient.hxx>
0026 #include <Standard_Integer.hxx>
0027 class Interface_InterfaceModel;
0028 class Interface_GeneralLib;
0029 class Interface_GTool;
0030 class Interface_Protocol;
0031 class Interface_Graph;
0032 class Standard_Transient;
0033 class Interface_EntityIterator;
0034
0035 //! This class only says for each Entity of a Model, if it is
0036 //! Shared or not by one or more other(s) of this Model
0037 //! It uses the General Service "Shared".
0038 class Interface_ShareFlags
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Creates a ShareFlags from a Model and builds required data
0044   //! (flags) by calling the General Service Library given as
0045   //! argument <lib>
0046   Standard_EXPORT Interface_ShareFlags(const Handle(Interface_InterfaceModel)& amodel,
0047                                        const Interface_GeneralLib&             lib);
0048
0049   //! Same as above, but GeneralLib is detained by a GTool
0050   Standard_EXPORT Interface_ShareFlags(const Handle(Interface_InterfaceModel)& amodel,
0051                                        const Handle(Interface_GTool)&          gtool);
0052
0053   //! Same as above, but GeneralLib is defined through a Protocol
0054   Standard_EXPORT Interface_ShareFlags(const Handle(Interface_InterfaceModel)& amodel,
0055                                        const Handle(Interface_Protocol)&       protocol);
0056
0057   //! Same as above, but works with the GTool of the Model
0058   Standard_EXPORT Interface_ShareFlags(const Handle(Interface_InterfaceModel)& amodel);
0059
0060   //! Creates a ShareFlags by querying information from a Graph
0061   //! (remark that Graph also has a method IsShared)
0062   Standard_EXPORT Interface_ShareFlags(const Interface_Graph& agraph);
0063
0064   //! Returns the Model used for the evaluation
0065   Standard_EXPORT Handle(Interface_InterfaceModel) Model() const;
0066
0067   //! Returns True if <ent> is Shared by one or more other
0068   //! Entity(ies) of the Model
0069   Standard_EXPORT Standard_Boolean IsShared(const Handle(Standard_Transient)& ent) const;
0070
0071   //! Returns the Entities which are not Shared (see their flags)
0072   Standard_EXPORT Interface_EntityIterator RootEntities() const;
0073
0074   //! Returns the count of root entities
0075   Standard_EXPORT Standard_Integer NbRoots() const;
0076
0077   //! Returns a root entity according its rank in the list of roots
0078   //! By default, it returns the first one
0079   Standard_EXPORT Handle(Standard_Transient) Root(const Standard_Integer num = 1) const;
0080
0081 protected:
0082 private:
0083   //! Computes flags at Creation time
0084   //!
0085   //! Normally, gtool suffices. But if a Graph is created from a
0086   //! GeneralLib directly, it cannot be used
0087   //! If <gtool> is defined, it has priority
0088   Standard_EXPORT void Evaluate(const Interface_GeneralLib&    lib,
0089                                 const Handle(Interface_GTool)& gtool);
0090
0091   Handle(Interface_InterfaceModel)     themodel;
0092   Interface_BitMap                     theflags;
0093   Handle(TColStd_HSequenceOfTransient) theroots;
0094 };
0095
0096 #endif // _Interface_ShareFlags_HeaderFile