iprm::TParamsPtrBase< ParamsSet, ParameterInterace > Class Template Reference

Help pointer wrapper for management of a parameter from the parameter set. More...

#include <TParamsPtr.h>

Inheritance diagram for iprm::TParamsPtrBase< ParamsSet, ParameterInterace >:

Public Types
typedef istd::TPointerBase< ParameterInterace >	BaseClass
using	NonConstParameterInterface = std::remove_const_t< ParameterInterace >

Public Member Functions
	TParamsPtrBase (ParameterInterace *ptr=NULL)
	TParamsPtrBase (ParamsSet *parameterSetPtr, const QByteArray &parameterId, bool isObligatory=true)
	Construct and initialize the pointer with the given parameter set and parameter ID.
	TParamsPtrBase (ParamsSet *parameterSetPtr, const icomp::TAttributeMember< iattr::CIdAttribute > &parameterIdAttribute, const icomp::TReferenceMember< NonConstParameterInterface > &defaultRef, bool isObligatory=true)
	Construct and initialize the pointer with the component parameters.
void	Init (ParamsSet *parameterSetPtr, const QByteArray &parameterId, bool isObligatory=true)
	Initialize the pointer with the given parameter set and parameter ID.
void	Init (ParamsSet *parameterSetPtr, const icomp::TAttributeMember< iattr::CIdAttribute > &parameterIdAttribute, const icomp::TReferenceMember< NonConstParameterInterface > &defaultRef, bool isObligatory=true)
	Initialize the pointer with the component parameters.
Public Member Functions inherited from istd::TPointerBase< ParameterInterace >
	TPointerBase (ParameterInterace *ptr=NULL)
	Construct and assign internal pointer.
void	SetPtr (ParameterInterace *ptr)
	Set value of internal stored pointer.
void	Reset ()
	Set internal pointer value to NULL.
ParameterInterace *	GetPtr () const
	Return access to internal stored pointer.
bool	IsValid () const
	Check if internal pointer not NULL.
void	Swap (TPointerBase &ptr)
	Swap two pointers.
ParameterInterace &	operator* () const
	Get an access to object pointed at.
CastedType	Cast () const
ParameterInterace *	operator-> () const
bool	operator== (const TPointerBase< ParameterInterace > &ptr) const
bool	operator== (const ParameterInterace *ptr) const
bool	operator!= (const TPointerBase< ParameterInterace > &ptr) const
bool	operator!= (const ParameterInterace *ptr) const
bool	operator< (const TPointerBase< ParameterInterace > &ptr) const
bool	operator< (const ParameterInterace *ptr) const
bool	operator> (const TPointerBase< ParameterInterace > &ptr) const
bool	operator> (const ParameterInterace *ptr) const
bool	operator<= (const TPointerBase< ParameterInterace > &ptr) const
bool	operator<= (const ParameterInterace *ptr) const
bool	operator>= (const TPointerBase< ParameterInterace > &ptr) const
bool	operator>= (const ParameterInterace *ptr) const

Additional Inherited Members
Protected Member Functions inherited from istd::TPointerBase< ParameterInterace >
TPointerBase< ParameterInterace > &	operator= (const TPointerBase< ParameterInterace > ptr)
ParameterInterace *&	GetPtrRef ()

Detailed Description

template<class ParamsSet, class ParameterInterace>
class iprm::TParamsPtrBase< ParamsSet, ParameterInterace >

Help pointer wrapper for management of a parameter from the parameter set.

Definition at line 26 of file TParamsPtr.h.

Member Typedef Documentation

BaseClass

template<class ParamsSet , class ParameterInterace >

typedef istd::TPointerBase<ParameterInterace> iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::BaseClass

Definition at line 29 of file TParamsPtr.h.

NonConstParameterInterface

template<class ParamsSet , class ParameterInterace >

using iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::NonConstParameterInterface = std::remove_const_t<ParameterInterace>

Definition at line 30 of file TParamsPtr.h.

Constructor & Destructor Documentation

TParamsPtrBase() [1/3]

template<class ParamsSet , class ParameterInterace >

iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::TParamsPtrBase

(

ParameterInterace *

ptr = NULL

)

Definition at line 79 of file TParamsPtr.h.

TParamsPtrBase() [2/3]

template<class ParamsSet , class ParameterInterace >

iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::TParamsPtrBase	(	ParamsSet *	parameterSetPtr,
		const QByteArray &	parameterId,
		bool	isObligatory = true
	)

Construct and initialize the pointer with the given parameter set and parameter ID.

Parameters

parameterSetPtr	parameter set, parameter will be taken from this set.
parameterId	ID of parameter in the set.
isObligatory	indicate, that this parameter is obligatory.

Definition at line 86 of file TParamsPtr.h.

TParamsPtrBase() [3/3]

template<class ParamsSet , class ParameterInterace >

iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::TParamsPtrBase	(	ParamsSet *	parameterSetPtr,
		const icomp::TAttributeMember< iattr::CIdAttribute > &	parameterIdAttribute,
		const icomp::TReferenceMember< NonConstParameterInterface > &	defaultRef,
		bool	isObligatory = true
	)

Construct and initialize the pointer with the component parameters.

Parameters

parameterSetPtr	parameter set, parameter will be taken from this set.
parameterIdAttribute	component attribute storing ID of parameter in the set.
defaultRef	component reference used if parameter is not found in the set.
isObligatory	indicate, that this parameter is obligatory.

Definition at line 94 of file TParamsPtr.h.

Member Function Documentation

Init() [1/2]

template<class ParamsSet , class ParameterInterace >

void iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::Init	(	ParamsSet *	parameterSetPtr,
		const icomp::TAttributeMember< iattr::CIdAttribute > &	parameterIdAttribute,
		const icomp::TReferenceMember< NonConstParameterInterface > &	defaultRef,
		bool	isObligatory = true
	)

Initialize the pointer with the component parameters.

Parameters

parameterSetPtr	parameter set, parameter will be taken from this set.
parameterIdAttribute	component attribute storing ID of parameter in the set.
defaultRef	component reference used if parameter is not found in the set.
isObligatory	indicate, that this parameter is obligatory.

Definition at line 155 of file TParamsPtr.h.

References icomp::TReferenceMember< Interface >::GetPtr(), icomp::TAttributeMember< Attribute >::IsValid(), icomp::TReferenceMember< Interface >::IsValid(), and NULL.

Init() [2/2]

template<class ParamsSet , class ParameterInterace >

void iprm::TParamsPtrBase< ParamsSet, ParameterInterace >::Init	(	ParamsSet *	parameterSetPtr,
		const QByteArray &	parameterId,
		bool	isObligatory = true
	)

Initialize the pointer with the given parameter set and parameter ID.

Parameters

parameterSetPtr	parameter set, parameter will be taken from this set.
parameterId	ID of parameter in the set.
isObligatory	indicate, that this parameter is obligatory.

Definition at line 105 of file TParamsPtr.h.

References I_IF_DEBUG, and NULL.

---

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

• Acf/Include/iprm/TParamsPtr.h