MantidQt::CustomDialogs::SphereDetails Class Reference

A widget to define a sphere. More...

#include <SampleShapeHelpers.h>

Inheritance diagram for MantidQt::CustomDialogs::SphereDetails:

Public Member Functions
	SphereDetails (QWidget *parent=nullptr)
	Default constructor.
QString	writeXML () const override
	Write the XML definition.
	~SphereDetails () override
	Default destructor.
Public Member Functions inherited from MantidQt::CustomDialogs::ShapeDetails
bool	getComplementFlag () const
	Get complement flag.
const QString &	getShapeID () const
void	setComplementFlag (bool flag)
	Set the complement flag.
	ShapeDetails (QWidget *parent=nullptr)
	Constructor.
	~ShapeDetails () override=default
	Constructor.

Private Attributes
PointGroupBox *	m_centre
	Centre point group box.
QLineEdit *	m_radius_box
	Line edit for radius value.
QComboBox *	m_runits
	Radius unit choice.

Static Private Attributes
static int	g_nspheres = 0
	The number of objects that currently exist.

Additional Inherited Members
Public Types inherited from MantidQt::CustomDialogs::ShapeDetails
enum	Unit { millimetre = 0 , centimetre = 1 , metre = 2 }
Static Public Member Functions inherited from MantidQt::CustomDialogs::ShapeDetails
static QString	convertToMetres (const QString &value, Unit start_unit)
	Convert a string value from the given unit to metres (static)
static QComboBox *	createLengthUnitsCombo ()
	Create a new length units box.
Protected Attributes inherited from MantidQt::CustomDialogs::ShapeDetails
QString	m_idvalue
	ID string of this object.

Detailed Description

A widget to define a sphere.

Definition at line 158 of file SampleShapeHelpers.h.

Constructor & Destructor Documentation

SphereDetails()

SphereDetails::SphereDetails

(

QWidget *

parent = nullptr

)

Default constructor.

Definition at line 221 of file SampleShapeHelpers.cpp.

References MantidQt::CustomDialogs::ShapeDetails::createLengthUnitsCombo(), g_nspheres, m_centre, MantidQt::CustomDialogs::ShapeDetails::m_idvalue, m_radius_box, and m_runits.

~SphereDetails()

MantidQt::CustomDialogs::SphereDetails::~SphereDetails ( )

inlineoverride

Default destructor.

Definition at line 170 of file SampleShapeHelpers.h.

References g_nspheres.

Member Function Documentation

writeXML()

QString SphereDetails::writeXML ( ) const

overridevirtual

Write the XML definition.

Implements MantidQt::CustomDialogs::ShapeDetails.

Definition at line 245 of file SampleShapeHelpers.cpp.

References MantidQt::CustomDialogs::ShapeDetails::convertToMetres(), m_centre, MantidQt::CustomDialogs::ShapeDetails::m_idvalue, m_radius_box, m_runits, and MantidQt::CustomDialogs::PointGroupBox::write3DElement().

Member Data Documentation

g_nspheres

int SphereDetails::g_nspheres = 0

staticprivate

The number of objects that currently exist.

Static counter.

Definition at line 163 of file SampleShapeHelpers.h.

Referenced by SphereDetails(), and ~SphereDetails().

m_centre

PointGroupBox* MantidQt::CustomDialogs::SphereDetails::m_centre

private

Centre point group box.

Definition at line 181 of file SampleShapeHelpers.h.

Referenced by SphereDetails(), and writeXML().

m_radius_box

QLineEdit* MantidQt::CustomDialogs::SphereDetails::m_radius_box

private

Line edit for radius value.

Definition at line 177 of file SampleShapeHelpers.h.

Referenced by SphereDetails(), and writeXML().

m_runits

QComboBox* MantidQt::CustomDialogs::SphereDetails::m_runits

private

Radius unit choice.

Definition at line 179 of file SampleShapeHelpers.h.

Referenced by SphereDetails(), and writeXML().

---

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

• qt/widgets/plugins/algorithm_dialogs/inc/MantidQtWidgets/Plugins/AlgorithmDialogs/SampleShapeHelpers.h
• qt/widgets/plugins/algorithm_dialogs/src/SampleShapeHelpers.cpp