1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-05 11:24:17 +03:00
occt/src/OSD/OSD_FileNode.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

139 lines
4.4 KiB
Plaintext
Executable File

-- Created on: 2024-03-15
-- Created by: Stephan GARNAUD (ARM)
-- Copyright (c) 1998-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.
deferred class FileNode from OSD
---Purpose: A class for 'File' and 'Directory' grouping common
-- methods.
-- The "file oriented" name means files or directories which are
-- in fact hard coded as files.
uses Protection, Date, Path, OpenMode, Error, AsciiString from TCollection
raises OSDError, ProgramError
is
Initialize;
---Purpose: Creates FileNode object
-- This is to be used with SetPath .
-- Allocate space for the file name and initializes this
-- name to an empty name.
---Level: Internal
Initialize (Name : Path )
---Purpose: Instantiates the object FileNode storing its name.
-- If a name is not found, it raises a program error.
---Level: Internal
raises ProgramError;
Path(me ; Name : out Path) is static;
---Purpose: Gets file name and path.
---Level: Public
SetPath(me : in out; Name : Path)
---Purpose: Sets file name and path.
-- If a name is not found, it raises a program error.
---Level: Public
raises ProgramError is static;
Exists ( me : in out ) returns Boolean
---Purpose: Returns TRUE if <me> exists.
---Level: Public
raises ProgramError is static;
Remove (me : in out)
---Purpose: Erases the FileNode from directory
---Level: Public
raises ProgramError is static;
Move (me : in out; NewPath : Path)
---Purpose: Moves <me> into another directory
---Level: Public
raises ProgramError is static;
Copy (me : in out; ToPath : Path )
---Purpose: Copies <me> to another FileNode
---Level: Public
raises ProgramError is static;
Protection (me : in out) returns Protection
---Purpose: Returns access mode of <me>.
---Level: Public
raises ProgramError is static;
SetProtection (me : out; Prot : Protection)
---Purpose: Changes protection of the FileNode
---Level: Public
raises ProgramError is static;
AccessMoment (me : in out) returns Date
---Purpose: Returns last write access.
-- On UNIX, AccessMoment and CreationMoment return the
-- same value.
---Level: Public
raises ProgramError is static;
CreationMoment (me : in out) returns Date
---Purpose: Returns creation date.
-- On UNIX, AccessMoment and CreationMoment return the
-- same value.
---Level: Public
raises ProgramError is static;
UserId (me : in out) returns Integer
---Purpose: Returns User Identification.
---Level: Public
raises ProgramError is static;
GroupId (me : in out) returns Integer
---Purpose: Returns Group Identification.
---Level: Public
raises ProgramError is static;
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
myPath : Path is protected; -- system independent path name
myFileChannel : Integer is protected; -- file descriptor
myError : Error is protected;
end FileNode from OSD;