[occt.git] / src / OSD / OSD_Directory.cdl

-- Created on: 1992-05-18
-- 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.

-- Updated:       J.P. TIRAULT August 1993
--                All classes are static class.


class Directory from OSD 

 ---Purpose: Management of directories (a set of directory oriented tools)
 
inherits FileNode 

uses Protection, Path 

is
 Create returns Directory;
    ---Purpose: Creates Directory object.
    --          It is initiliazed to an empty name.
    ---Level: Public

 Create (Name : Path) returns Directory;
    ---Purpose: Creates Directory object initialized with Name.
    ---Level: Public

 Build (me : in out ; Protect : Protection) is static;
    ---Purpose: Creates (physically) a directory.
    --          When a directory of the same name already exists, no error is
    --          returned, and only <Protect> is applied to the existing directory.
    --
    --          If Build is used and <me> is instantiated without a name,
    --          OSDError is raised.
    ---Level: Public

 BuildTemporary (myclass ) returns Directory;
    ---Purpose: Creates a temporary Directory in current directory.
    --          This directory is automatically removed when object dies.
    ---Level: Public
                                                    
end Directory from OSD;
Commit	Line	Data
b311480e	1	-- Created on: 1992-05-18
	2	-- Created by: Stephan GARNAUD (ARM)
	3	-- Copyright (c) 1992-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
d5f74e42	8	-- This library is free software; you can redistribute it and/or modify it under
d5f74e42	9	-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1	10	-- by the Free Software Foundation, with special exception defined in the file
	11	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
7fd59977	16
7fd59977	17	-- Updated: J.P. TIRAULT August 1993
	18	-- All classes are static class.
	19
	20
	21	class Directory from OSD
	22
ff8178ef	23	---Purpose: Management of directories (a set of directory oriented tools)
7fd59977	24
	25	inherits FileNode
	26
	27	uses Protection, Path
	28
	29	is
	30	Create returns Directory;
	31	---Purpose: Creates Directory object.
	32	-- It is initiliazed to an empty name.
	33	---Level: Public
	34
	35	Create (Name : Path) returns Directory;
	36	---Purpose: Creates Directory object initialized with Name.
	37	---Level: Public
	38
	39	Build (me : in out ; Protect : Protection) is static;
	40	---Purpose: Creates (physically) a directory.
	41	-- When a directory of the same name already exists, no error is
	42	-- returned, and only <Protect> is applied to the existing directory.
	43	--
	44	-- If Build is used and <me> is instantiated without a name,
	45	-- OSDError is raised.
	46	---Level: Public
	47
	48	BuildTemporary (myclass ) returns Directory;
	49	---Purpose: Creates a temporary Directory in current directory.
	50	-- This directory is automatically removed when object dies.
	51	---Level: Public
	52
	53	end Directory from OSD;
	54
	55