Mantid::API::SingleValueParameter< Derived, ValType > Class Template Reference

SingleValueParameter is a templated base class implementing CRTP. More...

#include <SingleValueParameter.h>

Inheritance diagram for Mantid::API::SingleValueParameter< Derived, ValType >:

Public Types
using	ValueType = ValType

Public Member Functions
ValType	getValue () const
bool	isValid () const override
bool	operator!= (const Derived &other) const
Derived &	operator= (const Derived &other)
SingleValueParameter< Derived, ValType > &	operator= (const SingleValueParameter< Derived, ValType > &other)
bool	operator== (const Derived &other) const
	SingleValueParameter ()
	Default constructor. Object is created in invalid state. More...
	SingleValueParameter (const SingleValueParameter< Derived, ValType > &other)
	SingleValueParameter (ValType value)
std::string	toXMLString () const override
Public Member Functions inherited from Mantid::API::ImplicitFunctionParameter
virtual ImplicitFunctionParameter *	clone () const =0
virtual std::string	getName () const =0
virtual bool	isValid () const =0
virtual std::string	toXMLString () const =0
virtual	~ImplicitFunctionParameter ()=default

Protected Attributes
bool	m_isValid
ValType	m_value
Protected Attributes inherited from Mantid::API::ImplicitFunctionParameter
bool	m_isValid {false}

Additional Inherited Members
Protected Member Functions inherited from Mantid::API::ImplicitFunctionParameter
std::string	parameterXMLTemplate (const std::string &valueXMLtext) const

Detailed Description

template<typename Derived, typename ValType>
class Mantid::API::SingleValueParameter< Derived, ValType >

SingleValueParameter is a templated base class implementing CRTP.

Allows strongly named concrete SingleValueParameters to be defined and used in a very simple manner.

Author

Owen Arnold, Tessella plc

Date

21/07/2011

Definition at line 27 of file SingleValueParameter.h.

Member Typedef Documentation

ValueType

template<typename Derived , typename ValType >

using Mantid::API::SingleValueParameter< Derived, ValType >::ValueType = ValType

Definition at line 29 of file SingleValueParameter.h.

Constructor & Destructor Documentation

SingleValueParameter() [1/3]

template<typename Derived , typename ValType >

Mantid::API::SingleValueParameter< Derived, ValType >::SingleValueParameter

(

ValType

value

)

Definition at line 123 of file SingleValueParameter.h.

SingleValueParameter() [2/3]

template<typename Derived , typename ValType >

Mantid::API::SingleValueParameter< Derived, ValType >::SingleValueParameter

Default constructor. Object is created in invalid state.

Definition at line 116 of file SingleValueParameter.h.

SingleValueParameter() [3/3]

template<typename Derived , typename ValType >

Mantid::API::SingleValueParameter< Derived, ValType >::SingleValueParameter

(

const SingleValueParameter< Derived, ValType > &

other

)

Definition at line 102 of file SingleValueParameter.h.

Member Function Documentation

getValue()

template<typename Derived , typename ValType >

ValType Mantid::API::SingleValueParameter< Derived, ValType >::getValue

Definition at line 50 of file SingleValueParameter.h.

References m_value.

isValid()

template<typename Derived , typename ValType >

bool Mantid::API::SingleValueParameter< Derived, ValType >::isValid

overridevirtual

Implements Mantid::API::ImplicitFunctionParameter.

Definition at line 58 of file SingleValueParameter.h.

operator!=()

template<typename Derived , typename ValType >

bool Mantid::API::SingleValueParameter< Derived, ValType >::operator!=

(

const Derived &

other

)

const

Definition at line 93 of file SingleValueParameter.h.

operator=() [1/2]

template<typename Derived , typename ValType >

Derived & Mantid::API::SingleValueParameter< Derived, ValType >::operator=

(

const Derived &

other

)

Definition at line 69 of file SingleValueParameter.h.

References m_value.

operator=() [2/2]

template<typename Derived , typename ValType >

SingleValueParameter< Derived, ValType > & Mantid::API::SingleValueParameter< Derived, ValType >::operator=

(

const SingleValueParameter< Derived, ValType > &

other

)

Definition at line 108 of file SingleValueParameter.h.

References m_value.

operator==()

template<typename Derived , typename ValType >

bool Mantid::API::SingleValueParameter< Derived, ValType >::operator==

(

const Derived &

other

)

const

Definition at line 83 of file SingleValueParameter.h.

References m_value.

toXMLString()

template<typename Derived , typename ValType >

std::string Mantid::API::SingleValueParameter< Derived, ValType >::toXMLString

overridevirtual

Implements Mantid::API::ImplicitFunctionParameter.

Definition at line 129 of file SingleValueParameter.h.

References m_value.

Member Data Documentation

m_isValid

template<typename Derived , typename ValType >

bool Mantid::API::SingleValueParameter< Derived, ValType >::m_isValid

protected

Definition at line 43 of file SingleValueParameter.h.

m_value

template<typename Derived , typename ValType >

ValType Mantid::API::SingleValueParameter< Derived, ValType >::m_value

protected

Definition at line 42 of file SingleValueParameter.h.

---

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

• Framework/API/inc/MantidAPI/SingleValueParameter.h