Mantid::API::ImplicitFunctionParameter Class Reference

Abstract parameter type for use with IImplicitFunctions. More...

#include <ImplicitFunctionParameter.h>

Inheritance diagram for Mantid::API::ImplicitFunctionParameter:

Public Member Functions
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 Member Functions
std::string	parameterXMLTemplate (const std::string &valueXMLtext) const

Protected Attributes
bool	m_isValid {false}

Detailed Description

Abstract parameter type for use with IImplicitFunctions.

Author

Owen Arnold, Tessella plc

Date

01/10/2010

Definition at line 37 of file ImplicitFunctionParameter.h.

Constructor & Destructor Documentation

~ImplicitFunctionParameter()

virtual Mantid::API::ImplicitFunctionParameter::~ImplicitFunctionParameter ( )

virtualdefault

Member Function Documentation

clone()

virtual ImplicitFunctionParameter * Mantid::API::ImplicitFunctionParameter::clone ( ) const

pure virtual

Implemented in Mantid::DataObjects::AffineMatrixParameter, and Mantid::MDAlgorithms::InvalidParameter.

getName()

virtual std::string Mantid::API::ImplicitFunctionParameter::getName ( ) const

pure virtual

Implemented in Mantid::DataObjects::AffineMatrixParameter, and Mantid::MDAlgorithms::InvalidParameter.

isValid()

virtual bool Mantid::API::ImplicitFunctionParameter::isValid ( ) const

pure virtual

Implemented in Mantid::MDAlgorithms::Vector3DParameter< Derived, ElemType >, Mantid::API::SingleValueParameter< Derived, ValType >, Mantid::API::VectorParameter< Derived, ElemType >, Mantid::DataObjects::AffineMatrixParameter, and Mantid::MDAlgorithms::InvalidParameter.

parameterXMLTemplate()

std::string Mantid::API::ImplicitFunctionParameter::parameterXMLTemplate ( const std::string &  valueXMLtext ) const

inlineprotected

Definition at line 53 of file ImplicitFunctionParameter.h.

References getName().

Referenced by Mantid::DataObjects::AffineMatrixParameter::toXMLString().

toXMLString()

virtual std::string Mantid::API::ImplicitFunctionParameter::toXMLString ( ) const

pure virtual

Implemented in Mantid::MDAlgorithms::Vector3DParameter< Derived, ElemType >, Mantid::API::SingleValueParameter< Derived, ValType >, Mantid::API::VectorParameter< Derived, ElemType >, Mantid::DataObjects::AffineMatrixParameter, and Mantid::MDAlgorithms::InvalidParameter.

Member Data Documentation

m_isValid

bool Mantid::API::ImplicitFunctionParameter::m_isValid {false}

protected

Definition at line 51 of file ImplicitFunctionParameter.h.

Referenced by Mantid::DataObjects::AffineMatrixParameter::AffineMatrixParameter(), Mantid::DataObjects::AffineMatrixParameter::isValid(), Mantid::DataObjects::AffineMatrixParameter::operator=(), and Mantid::DataObjects::AffineMatrixParameter::setMatrix().

---

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

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