mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-05-17 23:53:20 +08:00
d5f74e42d6
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.
111 lines
4.7 KiB
Plaintext
111 lines
4.7 KiB
Plaintext
-- Created on: 1992-11-02
|
|
-- Created by: Christian CAILLET
|
|
-- Copyright (c) 1992-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 EntityList from Interface -- inherits Storable
|
|
|
|
---Purpose : This class defines a list of Entities (Transient Objects),
|
|
-- it can be used as a field of other Transient classes, with
|
|
-- these features :
|
|
-- - oriented to define a little list, that is, slower than an
|
|
-- Array or a Map of Entities for a big count (about 100 and
|
|
-- over), but faster than a Sequence
|
|
-- - allows to work as a Sequence, limited to Clear, Append,
|
|
-- Remove, Access to an Item identified by its rank in the list
|
|
-- - space saving, compared to a Sequence, especially for little
|
|
-- amounts; better than an Array for a very little amount (less
|
|
-- than 10) but less good for a greater amount
|
|
--
|
|
-- Works in conjunction with EntityCluster
|
|
-- An EntityList gives access to a list of Entity Clusters, which
|
|
-- are chained (in one sense : Single List)
|
|
-- Remark : a new Item may not be Null, because this is the
|
|
-- criterium used for "End of List"
|
|
|
|
uses Type, Transient, EntityCluster, EntityIterator
|
|
|
|
raises OutOfRange, InterfaceError, NullObject
|
|
|
|
is
|
|
|
|
Create returns EntityList;
|
|
---Purpose : Creates a List as beeing empty
|
|
|
|
Clear (me : in out) is static;
|
|
---Purpose : Clears the List
|
|
|
|
Append (me : in out; ent : any Transient)
|
|
---Purpose : Appends an Entity, that is to the END of the list
|
|
-- (keeps order, but works slowerly than Add, see below)
|
|
raises NullObject is static;
|
|
-- Error if <ent> is Null
|
|
|
|
Add (me : in out; ent : any Transient)
|
|
---Purpose : Adds an Entity to the list, that is, with NO REGARD about the
|
|
-- order (faster than Append if count becomes greater than 10)
|
|
raises NullObject is static;
|
|
-- Error if <ent> is Null
|
|
|
|
Remove (me : in out; ent : any Transient)
|
|
---Purpose : Removes an Entity from the list, if it is there
|
|
raises NullObject is static;
|
|
-- Error if <ent> is Null
|
|
|
|
Remove (me : in out; num : Integer)
|
|
---Purpose : Removes an Entity from the list, given its rank
|
|
raises OutOfRange is static;
|
|
-- Error if <num> is not in range [1 - NbEntities]
|
|
|
|
IsEmpty (me) returns Boolean is static;
|
|
---Purpose : Returns True if the list is empty
|
|
|
|
NbEntities (me) returns Integer is static;
|
|
---Purpose : Returns count of recorded Entities
|
|
|
|
Value (me; num : Integer) returns any Transient
|
|
---Purpose : Returns an Item given its number. Beware about the way the
|
|
-- list was filled (see above, Add and Append)
|
|
raises OutOfRange is static;
|
|
-- Error if <num> is not in range [1 - NbEntities]
|
|
---C++ : return const &
|
|
|
|
SetValue (me : in out; num : Integer; ent : any Transient)
|
|
---Purpose : Returns an Item given its number. Beware about the way the
|
|
-- list was filled (see above, Add and Append)
|
|
raises OutOfRange, NullObject is static;
|
|
-- Error if <num> is not in [1 - NbEntities], or if <ent> is Null
|
|
|
|
|
|
FillIterator (me; iter : in out EntityIterator) is static;
|
|
---Purpose : fills an Iterator with the content of the list
|
|
-- (normal way to consult a list which has been filled with Add)
|
|
|
|
NbTypedEntities (me; atype : any Type) returns Integer is static;
|
|
---Purpose : Returns count of Entities of a given Type (0 : none)
|
|
|
|
TypedEntity (me; atype : any Type; num : Integer = 0) returns any Transient
|
|
---Purpose : Returns the Entity which is of a given type.
|
|
-- If num = 0 (D), there must be ONE AND ONLY ONE
|
|
-- If num > 0, returns the num-th entity of this type
|
|
raises InterfaceError is static;
|
|
-- Error if none or several found (num=0), or not enough (num>0)
|
|
|
|
fields
|
|
|
|
theval : Transient; -- Null(zero), a Transient(one), EntityCluster(more)
|
|
-- Mandatory only one field
|
|
|
|
end EntityList;
|