Mantid::DataObjects::NoShape Class Reference

PeakShapeNone : No peak shape. More...

#include <NoShape.h>

Inheritance diagram for Mantid::DataObjects::NoShape:

Public Member Functions
std::string	algorithmName () const override
	Return the algorithn name. More...
int	algorithmVersion () const override
	Return the algorithm version. More...
NoShape *	clone () const override
	Clone. More...
Kernel::SpecialCoordinateSystem	frame () const override
	Get the coordinate frame. More...
boost::optional< double >	radius (RadiusType) const override
	Radius. More...
std::string	shapeName () const override
	Return the shape name. More...
std::string	toJSON () const override
	Serialize. More...
Public Member Functions inherited from Mantid::Geometry::PeakShape
virtual std::string	algorithmName () const =0
	Algorithm. More...
virtual int	algorithmVersion () const =0
	Algorithm Version. More...
virtual PeakShape *	clone () const =0
	Deep copy this. More...
virtual Mantid::Kernel::SpecialCoordinateSystem	frame () const =0
	Coordinte frame used upon creation. More...
virtual boost::optional< double >	radius (RadiusType type) const =0
	Radius. More...
virtual std::string	shapeName () const =0
	Shape name. More...
virtual std::string	toJSON () const =0
	Serialize. More...
virtual	~PeakShape ()=default
	Destructor. More...

Static Public Member Functions
static const std::string	noShapeName ()
	Return the shape name. More...

Additional Inherited Members
Public Types inherited from Mantid::Geometry::PeakShape
enum	RadiusType { Radius = 0 , OuterRadius = 1 , InnerRadius = 2 }
	For selecting different radius types. More...

Detailed Description

PeakShapeNone : No peak shape.

Null Object. For unintegrated peaks.

Definition at line 17 of file NoShape.h.

Member Function Documentation

algorithmName()

std::string Mantid::DataObjects::NoShape::algorithmName ( ) const

overridevirtual

Return the algorithn name.

Implements Mantid::Geometry::PeakShape.

Definition at line 33 of file NoShape.cpp.

algorithmVersion()

int Mantid::DataObjects::NoShape::algorithmVersion ( ) const

overridevirtual

Return the algorithm version.

Implements Mantid::Geometry::PeakShape.

Definition at line 35 of file NoShape.cpp.

clone()

NoShape * Mantid::DataObjects::NoShape::clone ( ) const

overridevirtual

Clone.

Clone object as deep copy.

Returns

pointer to new object

Implements Mantid::Geometry::PeakShape.

Definition at line 31 of file NoShape.cpp.

frame()

Kernel::SpecialCoordinateSystem Mantid::DataObjects::NoShape::frame ( ) const

overridevirtual

Get the coordinate frame.

Implements Mantid::Geometry::PeakShape.

Definition at line 43 of file NoShape.cpp.

References Mantid::Kernel::None.

noShapeName()

const std::string Mantid::DataObjects::NoShape::noShapeName ( )

static

Return the shape name.

Definition at line 45 of file NoShape.cpp.

Referenced by shapeName().

radius()

boost::optional< double > Mantid::DataObjects::NoShape::radius ( RadiusType  type ) const

inlineoverridevirtual

Radius.

Implements Mantid::Geometry::PeakShape.

Definition at line 32 of file NoShape.h.

shapeName()

std::string Mantid::DataObjects::NoShape::shapeName ( ) const

overridevirtual

Return the shape name.

Return the unique shape name associated with this type.

Returns

Shape name

Implements Mantid::Geometry::PeakShape.

Definition at line 41 of file NoShape.cpp.

References noShapeName().

Referenced by toJSON().

toJSON()

std::string Mantid::DataObjects::NoShape::toJSON ( ) const

overridevirtual

Serialize.

Serialize to JSON object.

Returns

JSON object as std::string

Implements Mantid::Geometry::PeakShape.

Definition at line 18 of file NoShape.cpp.

References shapeName().

---

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

• Framework/DataObjects/inc/MantidDataObjects/NoShape.h
• Framework/DataObjects/src/NoShape.cpp