Mantid::API::NullCoordTransform Class Reference

NullCoordTransform : A transform that sets the outVector to have the same values as the inputVector. More...

#include <NullCoordTransform.h>

Inheritance diagram for Mantid::API::NullCoordTransform:

Public Member Functions
void	apply (const Mantid::coord_t *inputVector, Mantid::coord_t *outVector) const override
	Apply the transformation. More...
CoordTransform *	clone () const override
std::string	id () const override
	Coordinate transform id. More...
	NullCoordTransform (size_t ndims=3)
	Constructor. More...
std::string	toXMLString () const override
	Serialize to a string. More...
Public Member Functions inherited from Mantid::API::CoordTransform
virtual void	apply (const coord_t *inputVector, coord_t *outVector) const =0
Mantid::Kernel::VMD	applyVMD (const Mantid::Kernel::VMD &inputVector) const
	Wrapper for VMD. More...
virtual CoordTransform *	clone () const =0
	CoordTransform (const size_t inD, const size_t outD)
	Constructor. More...
size_t	getInD () const
size_t	getOutD () const
virtual std::string	id () const =0
virtual Mantid::Kernel::Matrix< coord_t >	makeAffineMatrix () const
virtual std::string	toXMLString () const =0
	Pure abstract methods to be implemented. More...
virtual	~CoordTransform ()=default

Private Attributes
size_t	m_ndims
	Number of dimensions. More...

Additional Inherited Members
Protected Attributes inherited from Mantid::API::CoordTransform
size_t	inD
	Input number of dimensions. More...
size_t	outD
	Output number of dimensions. More...

Detailed Description

NullCoordTransform : A transform that sets the outVector to have the same values as the inputVector.

Therefore has no-effect, for where transforms are not required.

Author

Owen Arnold

Date

14/09/2011

Definition at line 20 of file NullCoordTransform.h.

Constructor & Destructor Documentation

NullCoordTransform()

Mantid::API::NullCoordTransform::NullCoordTransform

(

size_t

ndims = 3

)

Constructor.

Parameters

ndims

: Number of dimensions

Definition at line 15 of file NullCoordTransform.cpp.

Member Function Documentation

apply()

void Mantid::API::NullCoordTransform::apply ( const Mantid::coord_t *  inputVector, Mantid::coord_t *  outVector  ) const

overridevirtual

Apply the transformation.

Parameters

inputVector	: pointer to the input vector
outVector	: pointer to the output vector.

Implements Mantid::API::CoordTransform.

Definition at line 35 of file NullCoordTransform.cpp.

References m_ndims.

clone()

CoordTransform * Mantid::API::NullCoordTransform::clone ( ) const

overridevirtual

Implements Mantid::API::CoordTransform.

Definition at line 17 of file NullCoordTransform.cpp.

References m_ndims.

id()

std::string Mantid::API::NullCoordTransform::id ( ) const

overridevirtual

Coordinate transform id.

Returns

the type of coordinate transform

Implements Mantid::API::CoordTransform.

Definition at line 28 of file NullCoordTransform.cpp.

toXMLString()

std::string Mantid::API::NullCoordTransform::toXMLString ( ) const

overridevirtual

Serialize to a string.

Exceptions

runtime_error

if used.

Implements Mantid::API::CoordTransform.

Definition at line 22 of file NullCoordTransform.cpp.

Member Data Documentation

m_ndims

size_t Mantid::API::NullCoordTransform::m_ndims

private

Number of dimensions.

Definition at line 30 of file NullCoordTransform.h.

Referenced by apply(), and clone().

---

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

• Framework/API/inc/MantidAPI/NullCoordTransform.h
• Framework/API/src/NullCoordTransform.cpp