IParameter< T > Class Template Reference

Collaboration diagram for IParameter< T >:

Public Member Functions
	IParameter ()=delete
	IParameter (const std::string &name, T *data, const std::string &parent_name, const std::function< void()> &onChange)
virtual	~IParameter ()=default
virtual IParameter *	clone (const std::string &new_name="") const =0
virtual bool	isNull () const
T &	getData () const
void	setData (T &data)
bool	hasSameData (const IParameter &other)
const std::string &	getName () const

Protected Member Functions
std::string	fullName () const

Protected Attributes
const std::string	m_name
T *	m_data
const std::string	m_parent_name
const std::function< void()>	m_onChange

Detailed Description

template<class T>
class IParameter< T >

Pure virtual base class for parameter wrapper classes RealParameter, ComponentParameter.

Holds a pointer to the wrapped parameter, a name, and a callback function to be called when the parameter is changed. This class is templated on the data type of the wrapped parameter.

Definition at line 28 of file IParameter.h.

Constructor & Destructor Documentation

IParameter() [1/2]

template<class T >

IParameter< T >::IParameter ( )

delete

IParameter() [2/2]

template<class T >

IParameter< T >::IParameter	(	const std::string &	name,
		T *	data,
		const std::string &	parent_name,
		const std::function< void()> &	onChange
	)

Definition at line 62 of file IParameter.h.

    : m_name(name), m_data(data), m_parent_name(parent_name), m_onChange(onChange)
{
    if (!m_data)
        throw std::runtime_error("Attempt to construct an IParameter with null data pointer");
}

References IParameter< T >::m_data.

~IParameter()

template<class T >

virtual IParameter< T >::~IParameter ( )

virtualdefault

Member Function Documentation

clone()

template<class T >

virtual IParameter* IParameter< T >::clone ( const std::string &  new_name = "" ) const

pure virtual

Implemented in RealParameter.

isNull()

template<class T >

virtual bool IParameter< T >::isNull ( ) const

inlinevirtual

Returns true if wrapped parameter was not initialized with proper real value.

Definition at line 39 of file IParameter.h.

{ return m_data ? false : true; }

References IParameter< T >::m_data.

getData()

template<class T >

T& IParameter< T >::getData ( ) const

inline

Definition at line 41 of file IParameter.h.

{ return *m_data; }

References IParameter< T >::m_data.

Referenced by IParameter< T >::hasSameData().

setData()

template<class T >

void IParameter< T >::setData ( T &  data )

inline

Definition at line 42 of file IParameter.h.

    {
        m_data = &data;
        m_onChange();
    }

References IParameter< T >::m_data, and IParameter< T >::m_onChange.

hasSameData()

template<class T >

bool IParameter< T >::hasSameData

(

const IParameter< T > &

other

)

Returns true if two parameters are pointing to the same raw data.

Definition at line 72 of file IParameter.h.

{
    return &getData() == &other.getData();
}

References IParameter< T >::getData().

Here is the call graph for this function:

getName()

template<class T >

const std::string& IParameter< T >::getName ( ) const

inline

Definition at line 49 of file IParameter.h.

{ return m_name; }

References IParameter< T >::m_name.

Referenced by ParameterPool::addParameter().

fullName()

template<class T >

std::string IParameter< T >::fullName ( ) const

inlineprotected

For use in error messages.

Definition at line 58 of file IParameter.h.

{ return m_parent_name + "/" + m_name; }

References IParameter< T >::m_name, and IParameter< T >::m_parent_name.

Member Data Documentation

m_name

template<class T >

const std::string IParameter< T >::m_name

protected

Definition at line 52 of file IParameter.h.

Referenced by IParameter< T >::fullName(), and IParameter< T >::getName().

m_data

template<class T >

T* IParameter< T >::m_data

protected

Definition at line 53 of file IParameter.h.

Referenced by IParameter< T >::getData(), IParameter< T >::IParameter(), IParameter< T >::isNull(), and IParameter< T >::setData().

m_parent_name

template<class T >

const std::string IParameter< T >::m_parent_name

protected

Definition at line 54 of file IParameter.h.

Referenced by IParameter< T >::fullName().

m_onChange

template<class T >

const std::function<void()> IParameter< T >::m_onChange

protected

Definition at line 55 of file IParameter.h.

Referenced by IParameter< T >::setData().

---

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

• /home/www/ba/Param/Base/IParameter.h