Interface_ParamSet Class Reference

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

#include <Interface_ParamSet.hxx>

Inheritance diagram for Interface_ParamSet:

Public Member Functions
	Interface_ParamSet (const int nres, const int 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).
int	Append (const char *const valval, const int lnval, const Interface_ParamType typ, const int 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.
int	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.
int	NbParams () const
	Returns the total count of parameters (including nexts).
const Interface_FileParameter &	Param (const int numnum) const
	Returns a parameter identified by its number.
Interface_FileParameter &	ChangeParam (const int numnum)
	Same as above, but in order to be modified on place.
void	SetParam (const int numnum, const Interface_FileParameter &FP)
	Changes a parameter identified by its number.
occ::handle< Interface_ParamList >	Params (const int numnum, const int 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.
void	Destroy ()
	Destructor (waiting for transparent memory management).
	~Interface_ParamSet () override
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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 int	nres,
		const int	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()

Interface_ParamSet::~Interface_ParamSet ( )

inlineoverride

Member Function Documentation

Append() [1/2]

int Interface_ParamSet::Append	(	const char *const	val,
		const int	lnval,
		const Interface_ParamType	typ,
		const int	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]

int 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 int

num

)

Same as above, but in order to be modified on place.

Destroy()

void Interface_ParamSet::Destroy

(

)

Destructor (waiting for transparent memory management).

NbParams()

int Interface_ParamSet::NbParams

(

)

const

Returns the total count of parameters (including nexts).

Param()

const Interface_FileParameter & Interface_ParamSet::Param

(

const int

num

)

const

Returns a parameter identified by its number.

Params()

occ::handle< Interface_ParamList > Interface_ParamSet::Params	(	const int	num,
		const int	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 int	num,
		const Interface_FileParameter &	FP )

Changes a parameter identified by its number.

---

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

• Interface_ParamSet.hxx