1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-16 10:54:53 +03:00
occt/src/Interface/Interface_ParamSet.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

97 lines
3.9 KiB
Plaintext
Executable File

-- Created on: 1992-10-29
-- 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 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;