Defines an ordered set of FileParameters, in a way to be efficient as in memory requirement or in speed. More...
#include <Interface_ParamSet.hxx>
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) More... | |
| 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. Optional 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 address is stored as such. Else, <val> is copied in a locally (quickly) managed Page of Characters Returns new count of recorded Parameters. More... | |
| 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. More... | |
| Standard_Integer | NbParams () const |
| Returns the total count of parameters (including nexts) More... | |
| const Interface_FileParameter & | Param (const Standard_Integer num) const |
| Returns a parameter identified by its number. More... | |
| Interface_FileParameter & | ChangeParam (const Standard_Integer num) |
| Same as above, but in order to be modified on place. More... | |
| void | SetParam (const Standard_Integer num, const Interface_FileParameter &FP) |
| Changes a parameter identified by its number. More... | |
| Handle< Interface_ParamList > | Params (const Standard_Integer num, const Standard_Integer nb) const |
| Builds and returns the sub-list corresponding to parameters, from "num" included, with count "nb" If <num> and <nb> are zero, returns the whole list. More... | |
| void | Destroy () |
| Destructor (waiting for transparent memory management) More... | |
| ~Interface_ParamSet () | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
Defines an ordered set of FileParameters, in a way to be efficient as in memory requirement or in speed.
Constructor & Destructor Documentation
◆ Interface_ParamSet()
| Interface_ParamSet::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)
◆ ~Interface_ParamSet()
|
inline |
Member Function Documentation
◆ Append() [1/2]
| Standard_Integer Interface_ParamSet::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. Optional 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 address is stored as such. Else, <val> is copied in a locally (quickly) managed Page of Characters Returns new count of recorded Parameters.
◆ Append() [2/2]
| Standard_Integer Interface_ParamSet::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.
◆ ChangeParam()
| Interface_FileParameter& Interface_ParamSet::ChangeParam | ( | const Standard_Integer | num | ) |
Same as above, but in order to be modified on place.
◆ Destroy()
| void Interface_ParamSet::Destroy | ( | ) |
Destructor (waiting for transparent memory management)
◆ NbParams()
| Standard_Integer Interface_ParamSet::NbParams | ( | ) | const |
Returns the total count of parameters (including nexts)
◆ Param()
| const Interface_FileParameter& Interface_ParamSet::Param | ( | const Standard_Integer | num | ) | const |
Returns a parameter identified by its number.
◆ Params()
| Handle< Interface_ParamList > Interface_ParamSet::Params | ( | const Standard_Integer | num, |
| const Standard_Integer | nb | ||
| ) | const |
Builds and returns the sub-list corresponding to parameters, from "num" included, with count "nb" If <num> and <nb> are zero, returns the whole list.
◆ SetParam()
| void Interface_ParamSet::SetParam | ( | const Standard_Integer | num, |
| const Interface_FileParameter & | FP | ||
| ) |
Changes a parameter identified by its number.
The documentation for this class was generated from the following file:
