Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Interface_ParamSet Class Reference

Defines an ordered set of FileParameters, in a way to be
efficient as in memory requirement or in speed

#include <Interface_ParamSet.hxx>

Inheritance diagram for Interface_ParamSet:
Inheritance graph
[legend]

Public Member Functions

 Interface_ParamSet (const Standard_Integer nres, const Standard_Integer nst=1)
 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)

Standard_Integer Append (const Standard_CString val, const Standard_Integer lnval, const Interface_ParamType typ, const Standard_Integer nument)
 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

Standard_Integer Append (const Interface_FileParameter &FP)
 Adds a parameter at the end of the ParamSet (transparent
about reservation and "Next")
Returns new count of recorded Parameters

Standard_Integer NbParams () const
 Returns the total count of parameters (including nexts)

const Interface_FileParameterParam (const Standard_Integer num) const
 Returns a parameter identified by its number

Interface_FileParameterChangeParam (const Standard_Integer num)
 Same as above, but in order to be modified on place

void SetParam (const Standard_Integer num, const Interface_FileParameter &FP)
 Changes a parameter identified by its number

Handle_Interface_ParamList Params (const Standard_Integer num, const Standard_Integer nb) const
 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

void Destroy ()
 Destructor (waiting for transparent memory management)

 ~Interface_ParamSet ()

Constructor & Destructor Documentation


Member Function Documentation

Handle_Interface_ParamList Interface_ParamSet::Params ( const Standard_Integer  num,
const Standard_Integer  nb 
) const

The documentation for this class was generated from the following file: