1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-07-15 12:35:51 +03:00
occt/src/Interface/Interface_ShareFlags.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

92 lines
3.6 KiB
Plaintext
Executable File

-- Created on: 1993-04-05
-- Created by: Christian CAILLET
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class ShareFlags from Interface
---Purpose : This class only says for each Entity of a Model, if it is
-- Shared or not by one or more other(s) of this Model
-- It uses the General Service "Shared".
uses HSequenceOfTransient from TColStd,
BitMap, InterfaceModel, EntityIterator,
GeneralLib, Protocol from Interface, GTool, Graph
raises DomainError, OutOfRange
is
Create (amodel : InterfaceModel; lib : GeneralLib) returns ShareFlags;
---Purpose : Creates a ShareFlags from a Model and builds required data
-- (flags) by calling the General Service Library given as
-- argument <lib>
Create (amodel : InterfaceModel; gtool : GTool from Interface)
returns ShareFlags;
---Purpose : Same as above, but GeneralLib is detained by a GTool
Create (amodel : InterfaceModel; protocol : Protocol from Interface)
returns ShareFlags;
---Purpose : Same as above, but GeneralLib is defined through a Protocol
Create (amodel : InterfaceModel) returns ShareFlags;
---Purpose : Same as above, but works with the GTool of the Model
Create (agraph : Graph) returns ShareFlags;
---Purpose : Creates a ShareFlags by querying informations from a Graph
-- (remark that Graph also has a method IsShared)
Evaluate (me : in out; lib : GeneralLib; gtool : GTool) is static private;
---Purpose : Computes flags at Creation time
--
-- Normally, gtool suffices. But if a Graph is created from a
-- GeneralLib directly, it cannot be used
-- If <gtool> is defined, it has priority
Model (me) returns InterfaceModel;
---Purpose : Returns the Model used for the evaluation
IsShared (me; ent : Transient) returns Boolean
---Purpose : Returns True if <ent> is Shared by one or more other
-- Entity(ies) of the Model
raises DomainError;
-- Error if <ent> does not come from the Model
RootEntities (me) returns EntityIterator;
---Purpose : Returns the Entities which are not Shared (see their flags)
NbRoots (me) returns Integer;
---Purpose : Returns the count of root entities
Root (me; num : Integer = 1) returns any Transient
---Purpose : Returns a root entity according its rank in the list of roots
-- By default, it returns the first one
raises OutOfRange;
-- Error if <num> if not between 1 and <NbRoots>
fields
themodel : InterfaceModel;
theflags : BitMap;
theroots : HSequenceOfTransient from TColStd;
end ShareFlags;