mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-05-06 10:36:12 +03:00
ff8178ef85
Mostly duplicated comments were removed and missing ones were moved into dedicated class CDL files. Some more duplicated comments were removed from CDL files. Correction of merge
420 lines
13 KiB
Plaintext
420 lines
13 KiB
Plaintext
-- Created on: 1992-09-11
|
|
-- Created by: Mireille MERCIEN
|
|
-- 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.
|
|
|
|
generic class HSequence from PCollection (Item as Storable) inherits Persistent
|
|
|
|
---Purpose: Definition of a sequence of elements indexed by
|
|
-- an Integer in range of 1..n
|
|
|
|
raises
|
|
NoSuchObject from Standard,
|
|
OutOfRange from Standard
|
|
|
|
|
|
private class SeqNode inherits PManaged
|
|
is
|
|
|
|
---Purpose: This class provides tools to manipulate a Sequence node.
|
|
-- Generic sequence of elements indexed by an integer in the range 1..N.
|
|
|
|
Create( TheLast: SeqNode ; TheItem: Item)
|
|
returns SeqNode from PCollection;
|
|
|
|
Create( TheItem: Item ; TheFirst: SeqNode )
|
|
returns SeqNode from PCollection;
|
|
|
|
Create( ThePrevious: SeqNode ; TheNext: SeqNode ; TheItem: Item )
|
|
returns SeqNode from PCollection;
|
|
|
|
Value(me) returns any Item;
|
|
---Level: Internal
|
|
---Purpose: Returns MyItem.
|
|
|
|
Next(me) returns SeqNode;
|
|
---Level: Internal
|
|
---Purpose: Returns MyNext.
|
|
|
|
Previous(me) returns SeqNode;
|
|
---Level: Internal
|
|
---Purpose: Returns MyPrevious.
|
|
|
|
SetValue( me:mutable; AnItem: Item);
|
|
---Level: Internal
|
|
---Purpose: Modifies the value of MyItem.
|
|
|
|
SetNext( me:mutable; ANode: SeqNode);
|
|
---Level: Internal
|
|
---Purpose: Modifies the value of MyNext.
|
|
|
|
SetPrevious( me:mutable; ANode: SeqNode);
|
|
---Level: Internal
|
|
---Purpose: Modifies the value of MyPrevious.
|
|
|
|
fields
|
|
MyPrevious : SeqNode;
|
|
MyItem : Item;
|
|
MyNext : SeqNode;
|
|
|
|
friends class HSequence from PCollection,
|
|
class SeqExplorer from PCollection
|
|
|
|
end;
|
|
|
|
class SeqExplorer
|
|
|
|
---Purpose: To explore a Sequence in an optimized way.
|
|
|
|
raises NoSuchObject from Standard,
|
|
OutOfRange from Standard
|
|
|
|
is
|
|
Create(S : HSequence from PCollection)
|
|
returns SeqExplorer from PCollection;
|
|
---Purpose: Creates an explorer on the sequence S.
|
|
-- Sets the explorer at the BEGINNING(index 1)
|
|
-- of the sequence S.
|
|
|
|
Value(me : in out ; Index : Integer)
|
|
returns any Item
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Value of the element indexed by Index in the
|
|
-- sequence <S>.
|
|
|
|
Contains(me : in out ; T : Item) returns Boolean;
|
|
---Level: Public
|
|
---Purpose: Returns True if the sequence <S> contains the element T.
|
|
|
|
Location(me : in out ; N : Integer;
|
|
T : Item; FromIndex : Integer;
|
|
ToIndex : Integer)
|
|
returns Integer
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Returns the index of the nth occurence of the element T
|
|
-- in the sequence <S>. The search starts from the index
|
|
-- FromIndex to the index ToIndex.
|
|
-- Returns 0 if the element is not present in the sub-sequence.
|
|
-- Raises an exception if the index is out of bounds.
|
|
|
|
Location(me : in out ; N : Integer; T : Item)
|
|
returns Integer
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Returns the index of the nth occurence of the element T
|
|
-- in the sequence <S>. The search starts from the beginning
|
|
-- to the end of the sequence.
|
|
-- Returns 0 if the element is not present in the sub-sequence.
|
|
-- Raises an exception if the index is out of bounds.
|
|
|
|
fields
|
|
CurrentItem : SeqNode;
|
|
CurrentIndex : Integer;
|
|
TheSequence : HSequence from PCollection;
|
|
end;
|
|
|
|
|
|
is
|
|
|
|
|
|
Create returns HSequence;
|
|
---Purpose: Creation of an empty sequence.
|
|
|
|
|
|
IsEmpty(me) returns Boolean;
|
|
---Level: Public
|
|
---Purpose: Returns True if the sequence <me> contains no elements.
|
|
|
|
Length(me) returns Integer;
|
|
---Level: Public
|
|
---Purpose: Returns the number of element(s) in the sequence.
|
|
-- Returns zero if the sequence is empty.
|
|
|
|
First(me) returns any Item
|
|
raises NoSuchObject from Standard;
|
|
---Level: Public
|
|
---Purpose: Returns the first element of the sequence <me>.
|
|
-- Raises an exception if the sequence is empty.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = (A B C)
|
|
-- returns A
|
|
|
|
Last(me) returns any Item
|
|
raises NoSuchObject from Standard ;
|
|
---Level: Public
|
|
---Purpose: Returns the last element of the sequence <me>.
|
|
-- Raises an exception if the sequence is empty
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = (A B C)
|
|
-- returns C
|
|
|
|
Clear(me : mutable);
|
|
---Level: Public
|
|
---Purpose: Removes all element(s) of the sequence <me>.
|
|
-- before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = ()
|
|
|
|
Append(me : mutable; T : Item);
|
|
---Level: Public
|
|
---Purpose: Pushes an element T at the end of the sequence <me>, thus
|
|
-- creating a new node.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = (A B C T)
|
|
|
|
Append(me : mutable; S : HSequence from PCollection);
|
|
---Level: Public
|
|
---Purpose: Pushes a sequence S at the end of the sequence <me>.
|
|
-- There is a concatenation of the two sequences by copying S.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- S = (D E F)
|
|
-- after
|
|
-- me = (A B C D E F)
|
|
-- S = (D E F)
|
|
|
|
Prepend(me : mutable; T : Item);
|
|
---Level: Public
|
|
---Purpose: Pushes an element T at the beginning of the sequence <me>,
|
|
-- thus creating a new node.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = (T A B C )
|
|
|
|
|
|
Prepend(me : mutable; S : HSequence from PCollection);
|
|
---Level: Public
|
|
---Purpose: Pushes a sequence S at the begining of the sequence <me>.
|
|
-- There is a concatenation of two sequences with a copy of S.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- S = (D E F)
|
|
-- after
|
|
-- me = (D E F A B C)
|
|
-- S = (D E F)
|
|
|
|
Reverse(me : mutable);
|
|
---Level: Public
|
|
---Purpose: Reverses the order of the sequence <me>.
|
|
---Example: before
|
|
-- me = (A B C)
|
|
-- after
|
|
-- me = (C B A)
|
|
|
|
InsertBefore(me : mutable; Index : Integer; T : Item)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Pushes an element before a specific index in the
|
|
-- sequence <me>.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B D), Index = 3, T = C
|
|
-- after
|
|
-- me = (A B C D )
|
|
|
|
InsertBefore(me : mutable ; Index : Integer;
|
|
S : HSequence from PCollection)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Pushes a sequence before a specific index in
|
|
-- the sequence <me> by copying S.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B F), Index = 3, S = (C D E)
|
|
-- after
|
|
-- me = (A B C D E F)
|
|
-- S = (C D E)
|
|
|
|
InsertAfter(me : mutable; Index : Integer; T : Item)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Pushes an element after a specific index in the
|
|
-- sequence <me>.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C), Index = 3, T = D
|
|
-- after
|
|
-- me = (A B C D )
|
|
|
|
InsertAfter(me : mutable ; Index : Integer;
|
|
S : HSequence from PCollection)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Pushes a sequence after a specific index in
|
|
-- the sequence <me> by copying S.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C), Index = 3, S = (D E F)
|
|
-- after
|
|
-- me = (A B C D E F)
|
|
-- S = (D E F)
|
|
|
|
Exchange(me : mutable; I, J : Integer) raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Swaps elements which are located in positions I and J
|
|
-- in the sequence <me>.
|
|
-- Raises an exception if the index I or J is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C), I = 1, J = 3
|
|
-- after
|
|
-- me = (C B A)
|
|
|
|
SubSequence(me; FromIndex, ToIndex : Integer)
|
|
returns HSequence
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Creation a sub-sequence with the elements from the
|
|
-- starting index I to the last index J
|
|
-- there is a partial copy of the sequence <me>
|
|
-- Raises an exception if the index is out of bounds or if
|
|
-- <ToIndex> is less than <FromIndex>.
|
|
---Example: before
|
|
-- me = (A B C D E), I = 2, J = 4
|
|
-- after
|
|
-- me = (A B C D E)
|
|
-- returns
|
|
-- (B C D)
|
|
|
|
Split(me : mutable; Index : Integer)
|
|
returns HSequence
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Split a sequence into two sub-sequences.
|
|
---Example: before
|
|
-- me = (A B C D) ,Index = 3
|
|
-- after
|
|
-- me = (A B)
|
|
-- returns
|
|
-- (C D)
|
|
|
|
SetValue(me : mutable; Index : Integer; T : Item)
|
|
raises OutOfRange;
|
|
---Level: Public
|
|
---Purpose: Modification of the element indexed by Index in
|
|
-- the sequence <me>.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B D), Index = 3, T = C
|
|
-- after
|
|
-- me = (A B C)
|
|
|
|
Value(me; Index : Integer) returns any Item
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Value of the element indexed by Index in the
|
|
-- sequence <me>.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C), Index = 1
|
|
-- after
|
|
-- me = (A B C)
|
|
-- returns
|
|
-- A
|
|
|
|
Contains(me; T : Item) returns Boolean;
|
|
---Level: Public
|
|
---Purpose: Returns True if the sequence <me> contains the element T
|
|
|
|
Location(me; N : Integer;
|
|
T : Item; FromIndex : Integer;
|
|
ToIndex : Integer) returns Integer
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Returns the index of the nth occurence of the element T
|
|
-- in the sequence <me>. The search starts from the index FromIndex to
|
|
-- the index ToIndex.
|
|
-- Returns 0 if the element is not present in the sub-sequence.
|
|
-- Raises an exception if the index is out of bounds or if
|
|
-- <ToIndex> is less than <FromIndex>.
|
|
---Example: before
|
|
-- me = (A B C B D E B H), N = 2, T = B, FromIndex = 3
|
|
-- ToIndex = 8
|
|
-- after
|
|
-- me = (A B C B D E B H)
|
|
-- returns 7
|
|
|
|
Location(me; N : Integer; T : Item) returns Integer
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Returns the index of the nth occurence of the element T
|
|
-- in the sequence <me>. The search starts from the beginning
|
|
-- to the end of the sequence.
|
|
-- Returns 0 if the element is not present in the sub-sequence.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C B D E B H), N = 3, T = B
|
|
-- after
|
|
-- me = (A B C B D E B H)
|
|
-- returns 7
|
|
|
|
Remove(me : mutable; Index : Integer)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Removes the element indexed by Index in the
|
|
-- sequence <me>.
|
|
-- Raises an exception if the index is out of bounds.
|
|
---Example: before
|
|
-- me = (A B C), Index = 3
|
|
-- after
|
|
-- me = (A B)
|
|
|
|
Remove(me : mutable; FromIndex, ToIndex : Integer)
|
|
raises OutOfRange from Standard;
|
|
---Level: Public
|
|
---Purpose: Removes the elements from the index FromIndex to the
|
|
-- index ToIndex in the sequence <me>.
|
|
-- Raises an exception if the indexes are out of bounds
|
|
---Example: before
|
|
-- me = (A B C D E F), FromIndex = 1 ToIndex = 3
|
|
-- after
|
|
-- me = (D E F)
|
|
|
|
GetFirst(me)
|
|
---Level: Internal
|
|
---Purpose: Returns "FirstItem" field.
|
|
returns SeqNode
|
|
is private;
|
|
|
|
GetLast(me)
|
|
---Level: Internal
|
|
---Purpose: Returns "LastItem" field
|
|
returns SeqNode
|
|
is private;
|
|
|
|
Destroy(me : mutable);
|
|
---C++: alias ~
|
|
|
|
fields
|
|
FirstItem : SeqNode;
|
|
LastItem : SeqNode;
|
|
Size : Integer;
|
|
|
|
friends class SeqExplorer from PCollection
|
|
|
|
end;
|
|
|
|
|
|
|
|
|