1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-10 11:34:06 +03:00
occt/src/TDataStd/TDataStd_ChildNodeIterator.cdl
vro 09f5e48e01 0025397: Iteration on a tree of nodes is too slow
Added "const Handle(TDataStd_TreeNode)&" for the method TDataStd_ChildNodeIterator::Value().
2014-10-30 11:34:56 +03:00

77 lines
2.6 KiB
Plaintext

-- Created on: 2000-01-26
-- Created by: Denis PASCAL
-- Copyright (c) 2000-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 ChildNodeIterator from TDataStd
---Purpose: Iterates on the ChildStepren step of a step, at the
-- first level only. It is possible to ask the
-- iterator to explore all the sub step levels of the
-- given one, with the option "allLevels".
uses TreeNode from TDataStd
is
Create
returns ChildNodeIterator from TDataStd;
---Purpose: Creates an empty iterator.
Create(aTreeNode : TreeNode from TDataStd;
allLevels : Boolean from Standard = Standard_False)
returns ChildNodeIterator from TDataStd;
---Purpose: Iterates on the ChildStepren of the given Step. If
-- <allLevels> option is set to true, it explores not
-- only the first, but all the sub Step levels.
Initialize(me : in out;
aTreeNode : TreeNode from TDataStd;
allLevels : Boolean from Standard = Standard_False);
---Purpose: Initializes the iteration on the Children Step of
-- the given Step. If <allLevels> option is set to
-- true, it explores not only the first, but all the
-- sub Step levels.
More(me) returns Boolean;
---C++: inline
---Purpose: Returns True if there is a current Item in the
-- iteration.
Next(me : in out);
---Purpose: Move to the next Item
NextBrother(me : in out);
---Purpose: Move to the next Brother. If there is none, go up
-- etc. This method is interesting only with
-- "allLevels" behavior, because it avoids to explore
-- the current Step ChildStepren.
Value(me) returns TreeNode from TDataStd;
---C++: inline
---C++: return const &
---Purpose: Returns the current item; a null Step if there is
-- no one.
fields
myNode : TreeNode from TDataStd;
myFirstLevel : Integer from Standard;
end ChildNodeIterator;