1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-10 11:34:06 +03:00
occt/src/OSD/OSD_Environment.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

104 lines
3.4 KiB
Plaintext

-- Created on: 2018-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.
class Environment from OSD
---Purpose: Management of system environment variables
-- An environment variable is composed of a variable name
-- and its value.
--
-- To be portable among various systems, environment variables
-- are local to a process.
uses Protection, Error, AsciiString from TCollection
raises ConstructionError, NullObject, OSDError
is
Create returns Environment;
---Purpose: Creates the object Environment.
---Level: Public
Create (Name : AsciiString) returns Environment
---Purpose: Creates an Environment variable initialized with value
-- set to an empty AsciiString.
---Level: Public
raises ConstructionError;
Create (Name, Value : AsciiString) returns Environment
---Purpose: Creates an Environment variable initialized with Value.
raises ConstructionError, NullObject;
-- ConstructionError is raised when invalid character is encountered.
---Level: Public
SetValue (me : in out; Value : AsciiString)
---Purpose: Changes environment variable value.
-- Raises ConstructionError either if the string contains
-- characters not in range of ' '...'~' or if the string
-- contains the character '$' which is forbiden.
---Level: Public
raises ConstructionError is static;
Value (me : in out) returns AsciiString is static ;
---Purpose: Gets the value of an environment variable
---Level: Public
SetName (me : in out; name : AsciiString)
---Purpose: Changes environment variable name.
-- Raises ConstructionError either if the string contains
-- characters not in range of ' '...'~' or if the string
-- contains the character '$' which is forbiden.
---Level: Public
raises ConstructionError is static;
Name (me ) returns AsciiString is static;
---Purpose: Gets the name of <me>.
---Level: Public
Build (me : in out) is static ;
---Purpose: Sets the value of an environment variable
-- into system (physically).
---Level: Public
Remove(me : in out) is static ;
---Purpose: Removes (physically) an environment variable
---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: Publi
fields
myName : AsciiString; --- Name of the variable
myValue : AsciiString;
myError : Error;
end Environment from OSD;