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

91 lines
3.6 KiB
Plaintext

-- Created on: 1992-10-29
-- 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 ParamSet from Interface inherits TShared
---Purpose : Defines an ordered set of FileParameters, in a way to be
-- efficient as in memory requirement or in speed
uses CString, ParamList, FileParameter, ParamType
raises OutOfRange
is
Create (nres : Integer; nst : Integer = 1) returns mutable ParamSet;
---Purpose : Creates an empty ParamSet, beginning at number "nst" and of
-- initial reservation "nres" : the "nres" first parameters
-- which follow "ndeb" (included) will be put in an Array
-- (a ParamList). The remainders are set in Next(s) ParamSet(s)
Append (me : mutable; val : CString; lnval : Integer; typ : ParamType;
nument : Integer)
returns Integer is static;
---Purpose : Adds a parameter defined as its Value (CString and length) and
-- Type. Optionnal EntityNumber (for FileReaderData) can be given
-- Allows a better memory management than Appending a
-- complete FileParameter
-- If <lnval> < 0, <val> is assumed to be managed elsewhere : its
-- adress is stored as such. Else, <val> is copied in a locally
-- (quickly) managed Page of Characters
-- Returns new count of recorded Parameters
Append (me : mutable; FP : FileParameter) returns Integer is static;
---Purpose : Adds a parameter at the end of the ParamSet (transparent
-- about reservation and "Next")
-- Returns new count of recorded Parameters
NbParams (me) returns Integer is static;
---Purpose : Returns the total count of parameters (including nexts)
Param (me; num : Integer) returns FileParameter
---Purpose : Returns a parameter identified by its number
raises OutOfRange is static;
-- Error if num < 1 or num > NbParams
---C++ : return const &
ChangeParam (me : mutable; num : Integer) returns FileParameter
---Purpose : Same as above, but in order to be modified on place
raises OutOfRange is static;
-- Error if num < 1 or num > NbParams
---C++ : return &
SetParam (me : mutable; num : Integer; FP : FileParameter)
raises OutOfRange is static;
---Purpose : Changes a parameter identified by its number
Params (me; num,nb : Integer) returns ParamList
raises OutOfRange is static;
---Purpose : Builds and returns the sub-list correspinding to parameters,
-- from "num" included, with count "nb"
-- If <num> and <nb> are zero, returns the whole list
Destroy (me : mutable) is static;
---Purpose : Destructor (waiting for transparent memory management)
---C++ : alias ~
fields
theval : PCharacter;
thelnval : Integer;
thelnres : Integer;
thenbpar : Integer;
themxpar : Integer;
thelist : ParamList;
thenext : ParamSet;
end ParamSet;