Files
OCCT/src/Interface/Interface_ShareFlags.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

86 lines
3.3 KiB
Plaintext

-- Created on: 1993-04-05
-- Created by: Christian CAILLET
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
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;