Public Types | Public Member Functions | List of all members
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 >:
istd::TPointerBase< const ParameterInterace >

Public Types

typedef istd::TPointerBase
< const ParameterInterace > 
BaseClass
 

Public Member Functions

 TParamsPtr (const ParameterInterace *ptr=NULL)
 
 TParamsPtr (const IParamsSet *parameterSetPtr, const QByteArray &parameterId, bool isObligatory=true)
 Construct and initialize the pointer with the given parameter set and parameter ID. More...
 
 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. More...
 
void Init (const IParamsSet *parameterSetPtr, const QByteArray &parameterId, bool isObligatory=true)
 Initialize the pointer with the given parameter set and parameter ID. More...
 
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. More...
 
- Public Member Functions inherited from istd::TPointerBase< const ParameterInterace >
 TPointerBase (const ParameterInterace *ptr=NULL)
 Construct and assign internal pointer. More...
 
void SetPtr (const ParameterInterace *ptr)
 Set value of internal stored pointer. More...
 
void Reset ()
 Set internal pointer value to NULL. More...
 
const ParameterInterace * GetPtr () const
 Return access to internal stored pointer. More...
 
bool IsValid () const
 Check if internal pointer not NULL. More...
 
void Swap (TPointerBase &ptr)
 Swap two pointers. More...
 
const ParameterInterace & operator* () const
 Get an access to object pointed at. More...
 
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
 

Additional Inherited Members

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

Detailed Description

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

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

Definition at line 25 of file TParamsPtr.h.

Member Typedef Documentation

template<class ParameterInterace >
typedef istd::TPointerBase<const ParameterInterace> iprm::TParamsPtr< ParameterInterace >::BaseClass

Definition at line 28 of file TParamsPtr.h.

Constructor & Destructor Documentation

template<class ParameterInterace >
iprm::TParamsPtr< ParameterInterace >::TParamsPtr ( const ParameterInterace *  ptr = NULL)

Definition at line 77 of file TParamsPtr.h.

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
parameterSetPtrparameter set, parameter will be taken from this set.
parameterIdID of parameter in the set.
isObligatoryindicate, that this parameter is obligatory.

Definition at line 84 of file TParamsPtr.h.

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
parameterSetPtrparameter set, parameter will be taken from this set.
parameterIdAttributecomponent attribute storing ID of parameter in the set.
defaultRefcomponent reference used if parameter is not found in the set.
isObligatoryindicate, that this parameter is obligatory.

Definition at line 91 of file TParamsPtr.h.

Member Function Documentation

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
parameterSetPtrparameter set, parameter will be taken from this set.
parameterIdID of parameter in the set.
isObligatoryindicate, that this parameter is obligatory.

Definition at line 102 of file TParamsPtr.h.

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

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
parameterSetPtrparameter set, parameter will be taken from this set.
parameterIdAttributecomponent attribute storing ID of parameter in the set.
defaultRefcomponent reference used if parameter is not found in the set.
isObligatoryindicate, that this parameter is obligatory.

Definition at line 139 of file TParamsPtr.h.

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


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy