1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-26 10:19:45 +03:00
occt/src/OSD/OSD_FileIterator.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

104 lines
3.5 KiB
Plaintext
Executable File

-- Created on: 1992-03-18
-- Created by: Stephan GARNAUD
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class FileIterator from OSD
---Purpose: Manages a breadth-only search for files in the specified
-- Path.
-- There is no specific order of results.
uses File, Path, Error, AsciiString from TCollection
raises OSDError
is
Create returns FileIterator ;
---WARNING : This method is not implemented on Windows NT System
---Purpose: Instantiates Object as empty Iterator;
---Level: Public
Create (where : Path ; Mask : AsciiString) returns FileIterator;
---Purpose: Instantiates Object as Iterator;
-- Wild-card "*" can be used in Mask the same way it
-- is used by unix shell for file names
---Level: Public
Destroy ( me : out );
---C++: alias ~
-- Only implemented on Windows NT
Initialize (me : in out ; where : Path ; Mask : AsciiString) is static;
---WARNING : This method is not implemented on Windows NT System
---Purpose: Initializes the current File Iterator
---Level: Public
More (me : in out) returns Boolean is static;
---Purpose: Returns TRUE if there are other items using the 'Tree'
-- method.
---Level: Public
Next (me : in out) is static;
---Purpose: Sets the iterator to the next item.
-- Returns the item value corresponding to the current
-- position of the iterator.
---Level: Public
Values (me : in out) returns File is static;
---Purpose: Returns the next file found .
---Level: Public
Failed (me) returns Boolean is static;
---Purpose: Returns TRUE if an error occurs
---Level: Public
Reset (me : in out) is static;
---Purpose: Resets error counter to zero
---Level: Public
Perror (me : in out)
---Purpose: Raises OSD_Error
---Level: Public
raises OSDError is static;
Error (me) returns Integer is static;
---Purpose: Returns error number if 'Failed' is TRUE.
---Level: Public
fields
TheIterator : File; -- The iterator item
myFlag : Integer;
myMask : AsciiString;
myPlace : AsciiString;
myDescr : Address ; -- unused by Windows NT code
myEntry : Address ; -- unused by Windows NT code
myInit : Integer ; -- unused by Windows NT code
myError : Error;
myHandle : Integer; -- Windows NT specific
myData : Address; -- Windows NT specific
myFirstCall : Boolean; -- Windows NT specific
end FileIterator from OSD;