Files
OCCT/src/Interface/Interface_FileParameter.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

75 lines
3.0 KiB
Plaintext
Executable File

-- Created on: 1992-02-03
-- Created by: Christian CAILLET
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
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;