Mantid::API::VectorParameter< Derived, ElemType > Class Template Reference

VectorParameter is abstract type implementing curiously recurring template pattern to implement common code associated with vector storage. More...

#include <VectorParameter.h>

Inheritance diagram for Mantid::API::VectorParameter< Derived, ElemType >:

Public Types
using	ValueType = ElemType

Public Member Functions
void	addValue (const size_t index, const ElemType &value)
Derived &	assignFrom (const Derived &other)
ElemType &	at (size_t index)
const ElemType *	getPointerToStart ()
size_t	getSize () const
bool	isValid () const override
bool	operator!= (const Derived &other) const
VectorParameter< Derived, ElemType > &	operator= (const VectorParameter< Derived, ElemType > &other)
bool	operator== (const Derived &other) const
ElemType &	operator[] (int index)
std::string	toXMLString () const override
	VectorParameter ()
	Default constructor.
	VectorParameter (const VectorParameter< Derived, ElemType > &other)
	VectorParameter (size_t size)
	~VectorParameter () override
	Destructor.
Public Member Functions inherited from Mantid::API::ImplicitFunctionParameter
virtual ImplicitFunctionParameter *	clone () const =0
virtual std::string	getName () const =0
virtual	~ImplicitFunctionParameter ()=default

Protected Attributes
ElemType *	m_arry
bool	m_isValid
size_t	m_size
Protected Attributes inherited from Mantid::API::ImplicitFunctionParameter
bool	m_isValid {false}

Private Member Functions
Derived &	operator= (const Derived &other)

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 ElemType>
class Mantid::API::VectorParameter< Derived, ElemType >

VectorParameter is abstract type implementing curiously recurring template pattern to implement common code associated with vector storage.

Author

Owen Arnold, Tessella plc

Date

21/07/2011

Definition at line 25 of file VectorParameter.h.

Member Typedef Documentation

ValueType

template<typename Derived , typename ElemType >

using Mantid::API::VectorParameter< Derived, ElemType >::ValueType = ElemType

Definition at line 27 of file VectorParameter.h.

Constructor & Destructor Documentation

VectorParameter() [1/3]

template<typename Derived , typename ElemType >

Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter

(

)

Default constructor.

Definition at line 135 of file VectorParameter.h.

References Mantid::API::VectorParameter< Derived, ElemType >::m_isValid.

VectorParameter() [2/3]

template<typename Derived , typename ElemType >

Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter

(

size_t

size

)

Definition at line 144 of file VectorParameter.h.

References Mantid::API::VectorParameter< Derived, ElemType >::m_arry, and Mantid::API::VectorParameter< Derived, ElemType >::m_isValid.

VectorParameter() [3/3]

template<typename Derived , typename ElemType >

Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter

(

const VectorParameter< Derived, ElemType > &

other

)

Definition at line 117 of file VectorParameter.h.

~VectorParameter()

template<typename Derived , typename ElemType >

Mantid::API::VectorParameter< Derived, ElemType >::~VectorParameter ( )

override

Destructor.

Definition at line 150 of file VectorParameter.h.

Member Function Documentation

addValue()

template<typename Derived , typename ElemType >

void Mantid::API::VectorParameter< Derived, ElemType >::addValue	(	const size_t	index,
		const ElemType &	value
	)

Definition at line 159 of file VectorParameter.h.

References index, and value.

assignFrom()

template<typename Derived , typename ElemType >

Derived & Mantid::API::VectorParameter< Derived, ElemType >::assignFrom

(

const Derived &

other

)

Definition at line 67 of file VectorParameter.h.

at()

template<typename Derived , typename ElemType >

ElemType & Mantid::API::VectorParameter< Derived, ElemType >::at

(

size_t

index

)

Definition at line 212 of file VectorParameter.h.

References index.

getPointerToStart()

template<typename Derived , typename ElemType >

const ElemType * Mantid::API::VectorParameter< Derived, ElemType >::getPointerToStart

(

)

Definition at line 203 of file VectorParameter.h.

getSize()

template<typename Derived , typename ElemType >

size_t Mantid::API::VectorParameter< Derived, ElemType >::getSize

(

)

const

Definition at line 195 of file VectorParameter.h.

References m_size.

isValid()

template<typename Derived , typename ElemType >

bool Mantid::API::VectorParameter< Derived, ElemType >::isValid ( ) const

overridevirtual

Implements Mantid::API::ImplicitFunctionParameter.

Definition at line 57 of file VectorParameter.h.

operator!=()

template<typename Derived , typename ElemType >

bool Mantid::API::VectorParameter< Derived, ElemType >::operator!=

(

const Derived &

other

)

const

Definition at line 108 of file VectorParameter.h.

operator=() [1/2]

template<typename Derived , typename ElemType >

Derived & Mantid::API::VectorParameter< Derived, ElemType >::operator= ( const Derived &  other )

private

operator=() [2/2]

template<typename Derived , typename ElemType >

VectorParameter< Derived, ElemType > & Mantid::API::VectorParameter< Derived, ElemType >::operator=

(

const VectorParameter< Derived, ElemType > &

other

)

Definition at line 123 of file VectorParameter.h.

References m_size.

operator==()

template<typename Derived , typename ElemType >

bool Mantid::API::VectorParameter< Derived, ElemType >::operator==

(

const Derived &

other

)

const

Definition at line 87 of file VectorParameter.h.

operator[]()

template<typename Derived , typename ElemType >

ElemType & Mantid::API::VectorParameter< Derived, ElemType >::operator[]

(

int

index

)

Definition at line 187 of file VectorParameter.h.

References index.

toXMLString()

template<typename Derived , typename ElemType >

std::string Mantid::API::VectorParameter< Derived, ElemType >::toXMLString ( ) const

overridevirtual

Implements Mantid::API::ImplicitFunctionParameter.

Definition at line 167 of file VectorParameter.h.

References m_size.

Member Data Documentation

m_arry

template<typename Derived , typename ElemType >

ElemType* Mantid::API::VectorParameter< Derived, ElemType >::m_arry

protected

Definition at line 45 of file VectorParameter.h.

Referenced by Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter().

m_isValid

template<typename Derived , typename ElemType >

bool Mantid::API::VectorParameter< Derived, ElemType >::m_isValid

protected

Definition at line 47 of file VectorParameter.h.

Referenced by Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter(), and Mantid::API::VectorParameter< Derived, ElemType >::VectorParameter().

m_size

template<typename Derived , typename ElemType >

size_t Mantid::API::VectorParameter< Derived, ElemType >::m_size

protected

Definition at line 46 of file VectorParameter.h.

---

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

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