Read an XML definition of a SampleEnvironmentSpec and produce a new SampleEnvironmentSpec object. More...

#include <SampleEnvironmentSpecParser.h>

Public Member Functions
SampleEnvironmentSpec_uptr	parse (const std::string &name, const std::string &filename, std::istream &istr)
	Takes a stream that is assumed to contain a single complete SampleEnvironmentSpec definition, reads the definition and produces a new SampleEnvironmentSpec object. More...

SampleEnvironmentSpec_uptr	parse (const std::string &name, Poco::XML::Element *element)
	Takes a pointer to an XML node that is assumed to point at a "environmentspec" tag. More...

Static Public Attributes
static constexpr const char *	ROOT_TAG = "environmentspec"

Private Types
using	MaterialsIndex = std::unordered_map< std::string, Kernel::Material >

Private Member Functions
std::string	findFile (const std::string &filename) const

void	loadFullSpecification (SampleEnvironmentSpec spec, Poco::XML::Element element)

std::shared_ptr< Geometry::MeshObject >	loadMeshFromSTL (Poco::XML::Element *stlFileElement) const
	Create a mesh shape from an STL input file. More...

void	LoadOptionalDoubleFromXML (Poco::XML::Element *componentElement, const std::string &elementName, double &targetVariable) const
	Load a double from an optional XML element. More...

void	parseAndAddComponents (SampleEnvironmentSpec spec, Poco::XML::Element element) const
	Take a <components> tag, parse the definitions and add them to the spec. More...

void	parseAndAddContainers (SampleEnvironmentSpec spec, Poco::XML::Element element) const
	Take a <containers> tag, parse the definitions and add them to the spec. More...

std::shared_ptr< Geometry::IObject >	parseComponent (Poco::XML::Element *element) const
	Parse a single definition of a component. More...

Geometry::Container_const_sptr	parseContainer (Poco::XML::Element *element) const
	Parse a single definition of a Can. More...

void	parseMaterials (Poco::XML::Element *element)
	Parse the set of materials in the document. More...

std::vector< double >	parseTranslationVector (const std::string &translationVectorStr) const
	Take a comma separated translation vector and return it as a std::vector. More...

void	validateRootElement (Poco::XML::Element *element) const
	Validate that the element points to the expected root element. More...

Private Attributes
std::string	m_filepath

MaterialsIndex	m_materials

Detailed Description

Read an XML definition of a SampleEnvironmentSpec and produce a new SampleEnvironmentSpec object.

Definition at line 29 of file SampleEnvironmentSpecParser.h.

Member Typedef Documentation

◆ MaterialsIndex

using Mantid::DataHandling::SampleEnvironmentSpecParser::MaterialsIndex = std::unordered_map<std::string, Kernel::Material>

private

Definition at line 39 of file SampleEnvironmentSpecParser.h.

Member Function Documentation

◆ findFile()

std::string Mantid::DataHandling::SampleEnvironmentSpecParser::findFile ( const std::string & filename ) const

private

Definition at line 338 of file SampleEnvironmentSpecParser.cpp.

References Mantid::DataHandling::exists(), Mantid::Kernel::SingletonHolder< T >::Instance(), and m_filepath.

Referenced by loadFullSpecification(), and loadMeshFromSTL().

◆ loadFullSpecification()

void Mantid::DataHandling::SampleEnvironmentSpecParser::loadFullSpecification	(	SampleEnvironmentSpec *	spec,
		Poco::XML::Element *	element
	)

private

Definition at line 204 of file SampleEnvironmentSpecParser.cpp.

References Mantid::DataHandling::SampleEnvironmentSpec::addComponent(), Mantid::DataHandling::SampleEnvironmentSpec::addContainer(), findFile(), Mantid::DataHandling::Mantid3MFFileIO::LoadFile(), Mantid::DataHandling::SampleEnvironmentSpec::ncans(), and Mantid::DataHandling::Mantid3MFFileIO::readMeshObjects().

Referenced by parse().

◆ loadMeshFromSTL()

std::shared_ptr< Geometry::MeshObject > Mantid::DataHandling::SampleEnvironmentSpecParser::loadMeshFromSTL ( Poco::XML::Element * stlFileElement ) const

private

Create a mesh shape from an STL input file.

This can't be in the ShapeFactory because that is in Geometry. This function needs acccess to the STL readers

Parameters

stlFileElement A pointer to an XML <stlfile> element

Returns: A new Object instance of the given type

Definition at line 373 of file SampleEnvironmentSpecParser.cpp.

References Mantid::DataHandling::LoadStlFactory::createReader(), Mantid::DataHandling::exists(), findFile(), Mantid::DataHandling::getScaleTypeFromStr(), LoadOptionalDoubleFromXML(), parseTranslationVector(), and rotation.

Referenced by parseComponent(), and parseContainer().

◆ LoadOptionalDoubleFromXML()

void Mantid::DataHandling::SampleEnvironmentSpecParser::LoadOptionalDoubleFromXML	(	Poco::XML::Element *	componentElement,
		const std::string &	attributeName,
		double &	targetVariable
	)		const

private

Load a double from an optional XML element.

Parameters

componentElement	XML element
attributeName	Attribute that double should be loaded from
targetVariable	Value read from element attribute

Definition at line 303 of file SampleEnvironmentSpecParser.cpp.

Referenced by loadMeshFromSTL().

◆ parse() [1/2]

SampleEnvironmentSpec_uptr Mantid::DataHandling::SampleEnvironmentSpecParser::parse	(	const std::string &	name,
		const std::string &	filename,
		std::istream &	istr
	)

Takes a stream that is assumed to contain a single complete SampleEnvironmentSpec definition, reads the definition and produces a new SampleEnvironmentSpec object.

Parameters