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_Disk.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

106 lines
3.3 KiB
Plaintext

-- Created on: 1992-05-27
-- Created by: Stephan GARNAUD (ARM)
-- 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.
class Disk from OSD
---Purpose: Disk management (a set of disk oriented tools)
uses Error, Path, CString from Standard, AsciiString from TCollection
raises OSDError
is
Create returns Disk;
---Purpose: Creates a disk object.
-- This is used only when a class contains a Disk field.
-- By default, its name is initialized to current working disk.
---Level: Public
Create (Name : Path) returns Disk;
---Purpose: Initializes the object Disk with the disk name
-- associated to the OSD_Path.
---Level: Public
Create (PathName : CString) returns Disk;
---Purpose: Initializes the object Disk with <PathName>.
-- <PathName> specifies any file within the mounted
-- file system.
-- Example : OSD_Disk myDisk ("/tmp")
-- Initializes a disk object with the mounted
-- file associated to /tmp.
---Level: Public
Name (me ) returns Path is static;
---Purpose: Returns disk name of <me>.
---Level: Public
SetName (me : in out; Name : Path) is static ;
---Purpose: Instantiates <me> with <Name>.
---Level: Public
DiskSize(me : in out) returns Integer is static ;
---Purpose: Returns total disk capacity in 512 bytes blocks.
---Level: Advanced
DiskFree(me : in out) returns Integer is static ;
---Purpose: Returns free available 512 bytes blocks on disk.
---Level: Advanced
DiskQuota(me : in out) returns Integer is static ;
---Purpose: Returns user's disk quota (in Bytes).
---Level: Advanced
SetDiskQuota(me : in out; QuotaSize : Integer) is static ;
---Purpose: Sets user's disk quota (in Bytes).
-- Warning: Needs system administrator privilege.
---Level: Advanced
SetQuotaOn(me : in out) is static;
---Purpose: Activates user's disk quota
-- Warning: Needs system administrator privilege.
---Level: Advanced
SetQuotaOff(me : in out) is static;
---Purpose: Deactivates user's disk quota
-- Warning: Needs system administrator privilege.
---Level: Advanced
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
DiskName : AsciiString;
myQuotaSize: Integer;
myError : Error;
end Disk from OSD;