Files
OCCT/src/Interface/Interface_FileParameter.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

69 lines
2.7 KiB
Plaintext

-- Created on: 1992-02-03
-- Created by: Christian CAILLET
-- 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 FileParameter from Interface
---Purpose : Auxiliary class to store a litteral parameter in a file
-- intermediate directory or in an UndefinedContent : a reference
-- type Parameter detains an Integer which is used to address a
-- record in the directory.
-- FileParameter is intended to be stored in a ParamSet : hence
-- memory management is performed by ParamSet, which calls Clear
-- to work, while the Destructor (see Destroy) does nothing.
-- Also a FileParameter can be read for consultation only, not to
-- be read from a Structure to be included into another one.
uses Integer, CString, AsciiString from TCollection, ParamType
is
Create returns FileParameter;
Init (me : in out; val : AsciiString from TCollection; typ : ParamType)
is static;
---Purpose : Fills fields (with Entity Number set to zero)
Init (me : in out; val : CString; typ : ParamType) is static;
---Purpose : Same as above, but builds the Value from a CString
CValue (me) returns CString is static;
---Purpose : Same as above, but as a CString (for immediate exploitation)
-- was C++ : return const
ParamType (me) returns ParamType is static;
---Purpose : Returns the type of the parameter
SetEntityNumber (me : in out; num : Integer) is static;
---Purpose : Allows to set a reference to an Entity in a numbered list
EntityNumber (me) returns Integer is static;
---Purpose : Returns value set by SetEntityNumber
Clear (me : in out) is static;
---Purpose : Clears stored data : frees memory taken for the String Value
Destroy (me : in out) is static;
---Purpose : Destructor. Does nothing because Memory is managed by ParamSet
---C++ : alias ~
fields
thetype : ParamType; -- for ParamType
theval : PCharacter; -- for Value
thenum : Integer; -- for EntityNumber
end FileParameter;