1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-10 18:51:21 +03:00
occt/src/OSD/OSD_FileNode.cdl
ski ff8178ef85 0024784: Move documentation in CDL files to proper location
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
2014-05-29 16:06:49 +04:00

130 lines
4.1 KiB
Plaintext

-- Created on: 2024-03-15
-- Created by: Stephan GARNAUD (ARM)
-- Copyright (c) 1998-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.
deferred class FileNode from OSD
---Purpose: A class for 'File' and 'Directory' grouping common
-- methods (file/directory manipulation tools).
-- 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
myError : Error is protected;
end FileNode from OSD;