Files
OCCT/src/IFSelect/IFSelect_PacketList.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

104 lines
4.2 KiB
Plaintext

-- Created on: 1994-09-02
-- Created by: Christian CAILLET
-- Copyright (c) 1994-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 PacketList from IFSelect inherits TShared
---Purpose : This class gives a simple way to return then consult a
-- list of packets, determined from the content of a Model,
-- by various criteria.
--
-- It allows to describe several lists with entities from a
-- given model, possibly more than one list knowing every entity,
-- and to determine the remaining list (entities in no lists) and
-- the duplications (with their count).
uses Array1OfInteger, IntList, HSequenceOfTransient, AsciiString,
EntityIterator, InterfaceModel
raises InterfaceError
is
Create (model : InterfaceModel) returns mutable PacketList;
---Purpose : Creates a PackList, empty, ready to receive entities from a
-- given Model
SetName (me : mutable; name : CString) is static;
---Purpose : Sets a name to a packet list : this makes easier a general
-- routine to print it. Default is "Packets"
Name (me) returns CString is static;
---Purpose : Returns the recorded name for a packet list
Model (me) returns InterfaceModel;
---Purpose : Returns the Model of reference
AddPacket (me : mutable);
---Purpose : Declares a new Packet, ready to be filled
-- The entities to be added will be added to this Packet
Add (me : mutable; ent : Transient)
---Purpose : Adds an entity from the Model into the current packet for Add
raises InterfaceError;
-- Error if <ent> is not from the Model, or if no AddPacket was
-- yet called
AddList (me : mutable; list : HSequenceOfTransient)
---Purpose : Adds an list of entities into the current packet for Add
raises InterfaceError;
-- Error if on of the items of <list> is not from the Model, or
-- if no AddPacket was yet called
NbPackets (me) returns Integer;
---Purpose : Returns the count of non-empty packets
NbEntities (me; numpack : Integer) returns Integer;
---Purpose : Returns the count of entities in a Packet given its rank, or 0
Entities (me; numpack : Integer) returns EntityIterator;
---Purpose : Returns the content of a Packet given its rank
-- Null Handle if <numpack> is out of range
HighestDuplicationCount (me) returns Integer;
---Purpose : Returns the highest number of packets which know a same entity
-- For no duplication, should be one
NbDuplicated (me; count : Integer; andmore : Boolean) returns Integer;
---Purpose : Returns the count of entities duplicated :
-- <count> times, if <andmore> is False, or
-- <count> or more times, if <andmore> is True
-- See Duplicated for more details
Duplicated (me; count : Integer; andmore : Boolean) returns EntityIterator;
---Purpose : Returns a list of entities duplicated :
-- <count> times, if <andmore> is False, or
-- <count> or more times, if <andmore> is True
-- Hence, count=2 & andmore=True gives all duplicated entities
-- count=1 gives non-duplicated entities (in only one packet)
-- count=0 gives remaining entities (in no packet at all)
fields
themodel : InterfaceModel;
thedupls : Array1OfInteger;
thepacks : IntList;
theflags : Array1OfInteger; -- for only once par packet !
thelast : Integer;
thebegin : Boolean;
thename : AsciiString;
end PacketList;