MantidQt::API::PlotAxis Class Reference

Deals with formatting a label for a plot axis for a given type of workspace. More...

#include <PlotAxis.h>

Public Member Functions
	PlotAxis ()=delete
	Disable default constructor.
	PlotAxis (const bool plottingDistribution, const Mantid::API::MatrixWorkspace &workspace)
	Constructor with just a workspace (reverse order to above so compiler doesn't convert a a bool to an size_t and call the wrong thing.
	PlotAxis (const Mantid::API::IMDWorkspace &workspace, const size_t index)
	Constructor with workspace & axis index.
	PlotAxis (const Mantid::Geometry::IMDDimension &dim)
	Constructor with an IMDDimension.
QString	title () const
	Create a new axis title.

Private Member Functions
void	titleFromDimension (const Mantid::Geometry::IMDDimension &dim)
	Creates a title suitable for an axis attached to the given dimension.
void	titleFromIndex (const Mantid::API::IMDWorkspace &workspace, const size_t index)
	Creates a title suitable for an axis attached to the given index.
void	titleFromYData (const Mantid::API::MatrixWorkspace &workspace, const bool plottingDistribution)
	Creates a title suitable for the Y data values.

Private Attributes
QString	m_title
	Title.

Detailed Description

Deals with formatting a label for a plot axis for a given type of workspace.

Definition at line 23 of file PlotAxis.h.

Constructor & Destructor Documentation

PlotAxis() [1/4]

MantidQt::API::PlotAxis::PlotAxis	(	const Mantid::API::IMDWorkspace &	workspace,
		const size_t	index
	)

Constructor with workspace & axis index.

PlotAxis() [2/4]

MantidQt::API::PlotAxis::PlotAxis

(

const Mantid::Geometry::IMDDimension &

dim

)

Constructor with an IMDDimension.

PlotAxis() [3/4]

MantidQt::API::PlotAxis::PlotAxis	(	const bool	plottingDistribution,
		const Mantid::API::MatrixWorkspace &	workspace
	)

Constructor with just a workspace (reverse order to above so compiler doesn't convert a a bool to an size_t and call the wrong thing.

PlotAxis() [4/4]

MantidQt::API::PlotAxis::PlotAxis ( )

delete

Disable default constructor.

Member Function Documentation

title()

QString MantidQt::API::PlotAxis::title

(

)

const

Create a new axis title.

titleFromDimension()

void MantidQt::API::PlotAxis::titleFromDimension ( const Mantid::Geometry::IMDDimension &  dim )

private

Creates a title suitable for an axis attached to the given dimension.

titleFromIndex()

void MantidQt::API::PlotAxis::titleFromIndex ( const Mantid::API::IMDWorkspace &  workspace, const size_t  index  )

private

Creates a title suitable for an axis attached to the given index.

titleFromYData()

void MantidQt::API::PlotAxis::titleFromYData ( const Mantid::API::MatrixWorkspace &  workspace, const bool  plottingDistribution  )

private

Creates a title suitable for the Y data values.

Member Data Documentation

m_title

QString MantidQt::API::PlotAxis::m_title

private

Title.

Definition at line 49 of file PlotAxis.h.

---

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

• qt/widgets/common/inc/MantidQtWidgets/Common/PlotAxis.h