MantidQt::CustomDialogs::CylinderDetails Class Reference

A widget to define a cylinder. More...

#include <SampleShapeHelpers.h>

Inheritance diagram for MantidQt::CustomDialogs::CylinderDetails:

Public Member Functions
	CylinderDetails (QWidget *parent=nullptr)
	Default constructor. More...
QString	writeXML () const override
	Write the XML definition. More...
	~CylinderDetails () override
	Default destructor. More...
Public Member Functions inherited from MantidQt::CustomDialogs::ShapeDetails
bool	getComplementFlag () const
	Get complement flag. More...
QString	getShapeID () const
	Get the id string. More...
void	setComplementFlag (bool flag)
	Set the complement flag. More...
	ShapeDetails (QWidget *parent=nullptr)
	Constructor. More...
virtual QString	writeXML () const =0
	Write out the XML definition for this shape. More...
	~ShapeDetails () override=default
	Constructor. More...

Private Attributes
PointGroupBox *	m_axis
QLineEdit *	m_height_box
QComboBox *	m_hunits
PointGroupBox *	m_lower_centre
	Centre and axis point boxes. More...
QLineEdit *	m_radius_box
	Line edits to enter values. More...
QComboBox *	m_runits

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

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) More...
static QComboBox *	createLengthUnitsCombo ()
	Create a new length units box. More...
Protected Attributes inherited from MantidQt::CustomDialogs::ShapeDetails
QString	m_idvalue
	ID string of this object. More...

Detailed Description

A widget to define a cylinder.

Definition at line 188 of file SampleShapeHelpers.h.

Constructor & Destructor Documentation

CylinderDetails()

CylinderDetails::CylinderDetails

(

QWidget *

parent = nullptr

)

Default constructor.

Update number of sphere objects and the set the ID of this one

Definition at line 264 of file SampleShapeHelpers.cpp.

References MantidQt::CustomDialogs::ShapeDetails::createLengthUnitsCombo(), g_ncylinders, m_axis, m_height_box, m_hunits, MantidQt::CustomDialogs::ShapeDetails::m_idvalue, m_lower_centre, m_radius_box, and m_runits.

~CylinderDetails()

MantidQt::CustomDialogs::CylinderDetails::~CylinderDetails ( )

inlineoverride

Default destructor.

Definition at line 200 of file SampleShapeHelpers.h.

References g_ncylinders.

Member Function Documentation

writeXML()

QString CylinderDetails::writeXML ( ) const

overridevirtual

Write the XML definition.

Implements MantidQt::CustomDialogs::ShapeDetails.

Definition at line 302 of file SampleShapeHelpers.cpp.

References MantidQt::CustomDialogs::ShapeDetails::convertToMetres(), m_axis, m_height_box, m_hunits, MantidQt::CustomDialogs::ShapeDetails::m_idvalue, m_lower_centre, m_radius_box, m_runits, and MantidQt::CustomDialogs::PointGroupBox::write3DElement().

Member Data Documentation

g_ncylinders

int CylinderDetails::g_ncylinders = 0

staticprivate

The number of objects that currently exist.

Static counter.

Definition at line 193 of file SampleShapeHelpers.h.

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

m_axis

PointGroupBox * MantidQt::CustomDialogs::CylinderDetails::m_axis

private

Definition at line 211 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), and writeXML().

m_height_box

QLineEdit * MantidQt::CustomDialogs::CylinderDetails::m_height_box

private

Definition at line 207 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), and writeXML().

m_hunits

QComboBox * MantidQt::CustomDialogs::CylinderDetails::m_hunits

private

Definition at line 209 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), and writeXML().

m_lower_centre

PointGroupBox* MantidQt::CustomDialogs::CylinderDetails::m_lower_centre

private

Centre and axis point boxes.

Definition at line 211 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), and writeXML().

m_radius_box

QLineEdit* MantidQt::CustomDialogs::CylinderDetails::m_radius_box

private

Line edits to enter values.

Definition at line 207 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), and writeXML().

m_runits

QComboBox* MantidQt::CustomDialogs::CylinderDetails::m_runits

private

Definition at line 209 of file SampleShapeHelpers.h.

Referenced by CylinderDetails(), 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