iprm::TParamsPtr< ParameterInterace > Class Template Reference

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

#include <TParamsPtr.h>

Inheritance diagram for iprm::TParamsPtr< ParameterInterace >:

Collaboration diagram for iprm::TParamsPtr< ParameterInterace >:

Public Types
typedef istd::TPointerBase< const ParameterInterace >	BaseClass

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

Additional Inherited Members
Protected Member Functions inherited from istd::TPointerBase< const ParameterInterace >
TPointerBase< const ParameterInterace > &	operator= (const TPointerBase< const ParameterInterace > ptr)
const ParameterInterace *&	GetPtrRef ()
void	Swap (TPointerBase &ptr)
	Swap two pointers.
Protected Attributes inherited from istd::TPointerBase< const ParameterInterace >
const ParameterInterace *	m_ptr

Detailed Description

template<class ParameterInterace>
class iprm::TParamsPtr< ParameterInterace >

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

Definition at line 31 of file TParamsPtr.h.

Member Typedef Documentation

BaseClass

template<class ParameterInterace >

istd::TPointerBase<const ParameterInterace> iprm::TParamsPtr< ParameterInterace >::BaseClass

Definition at line 34 of file TParamsPtr.h.

Constructor & Destructor Documentation

TParamsPtr() [1/3]

template<class ParameterInterace >

iprm::TParamsPtr< ParameterInterace >::TParamsPtr

(

const ParameterInterace *

ptr = nullptr

)

Definition at line 83 of file TParamsPtr.h.

TParamsPtr() [2/3]

template<class ParameterInterace >

iprm::TParamsPtr< ParameterInterace >::TParamsPtr	(	const IParamsSet *	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 90 of file TParamsPtr.h.

TParamsPtr() [3/3]

template<class ParameterInterace >

iprm::TParamsPtr< ParameterInterace >::TParamsPtr	(	const IParamsSet *	parameterSetPtr,
		const icomp::TAttributeMember< iattr::CIdAttribute > &	parameterIdAttribute,
		const icomp::TReferenceMember< ParameterInterace > &	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 97 of file TParamsPtr.h.

Member Function Documentation

Init() [1/2]

template<class ParameterInterace >

void iprm::TParamsPtr< ParameterInterace >::Init	(	const IParamsSet *	parameterSetPtr,
		const icomp::TAttributeMember< iattr::CIdAttribute > &	parameterIdAttribute,
		const icomp::TReferenceMember< ParameterInterace > &	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 143 of file TParamsPtr.h.

References icomp::TReferenceMember< Interface >::get(), istd::CClassInfo::GetName(), iprm::IParamsSet::GetParameter(), iprm::IParamsSet::GetParamIds(), icomp::TAttributeMember< Attribute >::IsValid(), and icomp::TReferenceMember< Interface >::IsValid().

Init() [2/2]

template<class ParameterInterace >

void iprm::TParamsPtr< ParameterInterace >::Init	(	const IParamsSet *	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 108 of file TParamsPtr.h.

References iprm::IParamsSet::GetParameter(), iprm::IParamsSet::GetParamIds(), and I_IF_DEBUG.

---

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

• iprm/TParamsPtr.h