MantidQt::CustomDialogs::InfiniteCylinderDetails Class Reference

A widget to define an infinite cylinder. More...

#include <SampleShapeHelpers.h>

Inheritance diagram for MantidQt::CustomDialogs::InfiniteCylinderDetails:

Public Member Functions
	InfiniteCylinderDetails (QWidget *parent=nullptr)
	Default constructor.
QString	writeXML () const override
	Write the XML definition.
	~InfiniteCylinderDetails () 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_axis
PointGroupBox *	m_centre
	Centre and axis point boxes.
QLineEdit *	m_radius_box
	Line edits to enter values.
QComboBox *	m_runits

Static Private Attributes
static int	g_ninfcyls = 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 an infinite cylinder.

Definition at line 216 of file SampleShapeHelpers.h.

Constructor & Destructor Documentation

InfiniteCylinderDetails()

InfiniteCylinderDetails::InfiniteCylinderDetails

(

QWidget *

parent = nullptr

)

Default constructor.

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

Definition at line 328 of file SampleShapeHelpers.cpp.

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

~InfiniteCylinderDetails()

MantidQt::CustomDialogs::InfiniteCylinderDetails::~InfiniteCylinderDetails ( )

inlineoverride

Default destructor.

Definition at line 228 of file SampleShapeHelpers.h.

References g_ninfcyls.

Member Function Documentation

writeXML()

QString InfiniteCylinderDetails::writeXML ( ) const

overridevirtual

Write the XML definition.

Implements MantidQt::CustomDialogs::ShapeDetails.

Definition at line 357 of file SampleShapeHelpers.cpp.

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

Member Data Documentation

g_ninfcyls

int InfiniteCylinderDetails::g_ninfcyls = 0

staticprivate

The number of objects that currently exist.

Static counter.

Definition at line 221 of file SampleShapeHelpers.h.

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

m_axis

PointGroupBox * MantidQt::CustomDialogs::InfiniteCylinderDetails::m_axis

private

Definition at line 239 of file SampleShapeHelpers.h.

Referenced by InfiniteCylinderDetails(), and writeXML().

m_centre

PointGroupBox* MantidQt::CustomDialogs::InfiniteCylinderDetails::m_centre

private

Centre and axis point boxes.

Definition at line 239 of file SampleShapeHelpers.h.

Referenced by InfiniteCylinderDetails(), and writeXML().

m_radius_box

QLineEdit* MantidQt::CustomDialogs::InfiniteCylinderDetails::m_radius_box

private

Line edits to enter values.

Definition at line 235 of file SampleShapeHelpers.h.

Referenced by InfiniteCylinderDetails(), and writeXML().

m_runits

QComboBox* MantidQt::CustomDialogs::InfiniteCylinderDetails::m_runits

private

Definition at line 237 of file SampleShapeHelpers.h.

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