Mantid::Geometry::InstrumentMetadata Class Reference

InstrumentMetadata : metadata related to the entire instrument. More...

#include <InstrumentMetadata.h>

Public Member Functions
const std::string &	defaultAxis () const
const std::string &	defaultView () const
const std::string &	filename () const
bool	hasPhysicalInstrument () const
	INDIRECT GEOMETRY INSTRUMENTS ONLY : true if a physical instrument was specified, distinct from the neutronic one held by the workspace.
	InstrumentMetadata (const Types::Core::DateAndTime &validFromDate, const Types::Core::DateAndTime &validToDate, const std::string &filename, const std::string &xmlText, const std::string &defaultView, const std::string &defaultAxis, const std::shared_ptr< const ComponentInfo > &physicalComponentInfo=nullptr, const std::shared_ptr< const DetectorInfo > &physicalDetectorInfo=nullptr)
const ComponentInfo &	physicalComponentInfo () const
	INDIRECT GEOMETRY INSTRUMENTS ONLY : the ComponentInfo of the physical instrument.
const DetectorInfo &	physicalDetectorInfo () const
	INDIRECT GEOMETRY INSTRUMENTS ONLY : the DetectorInfo of the physical instrument.
void	setDefaultView (const std::string &defaultView)
void	setDefaultViewAxis (const std::string &defaultAxis)
void	setFileName (const std::string &filename)
void	setXmlText (const std::string &xmlText)
const Types::Core::DateAndTime &	validFromDate () const
const Types::Core::DateAndTime &	validToDate () const
const std::string &	xmlText () const

Private Attributes
std::string	m_defaultAxis
std::string	m_defaultView
std::string	m_filename
std::shared_ptr< const ComponentInfo >	m_physicalComponentInfo
std::shared_ptr< const DetectorInfo >	m_physicalDetectorInfo
Types::Core::DateAndTime	m_validFromDate
Types::Core::DateAndTime	m_validToDate
std::string	m_xmlText

Detailed Description

InstrumentMetadata : metadata related to the entire instrument.

• valid-from/to dates
• source IDF filename
• raw IDF XML text
• default instrument-view type/axis
• physical/neutronic instrument split for indirect-geometry instruments Created at instrument load. The filename, XML text and default view/axis can be updated via setters.

Definition at line 27 of file InstrumentMetadata.h.

Constructor & Destructor Documentation

InstrumentMetadata()

Mantid::Geometry::InstrumentMetadata::InstrumentMetadata	(	const Types::Core::DateAndTime &	validFromDate,
		const Types::Core::DateAndTime &	validToDate,
		const std::string &	filename,
		const std::string &	xmlText,
		const std::string &	defaultView,
		const std::string &	defaultAxis,
		const std::shared_ptr< const ComponentInfo > &	physicalComponentInfo = nullptr,
		const std::shared_ptr< const DetectorInfo > &	physicalDetectorInfo = nullptr
	)

Definition at line 15 of file InstrumentMetadata.cpp.

Member Function Documentation

defaultAxis()

const std::string & Mantid::Geometry::InstrumentMetadata::defaultAxis

(

)

const

Definition at line 35 of file InstrumentMetadata.cpp.

References m_defaultAxis.

Referenced by setDefaultViewAxis().

defaultView()

const std::string & Mantid::Geometry::InstrumentMetadata::defaultView

(

)

const

Definition at line 33 of file InstrumentMetadata.cpp.

References m_defaultView.

Referenced by setDefaultView().

filename()

const std::string & Mantid::Geometry::InstrumentMetadata::filename

(

)

const

Definition at line 29 of file InstrumentMetadata.cpp.

References m_filename.

Referenced by setFileName().

hasPhysicalInstrument()

bool Mantid::Geometry::InstrumentMetadata::hasPhysicalInstrument

(

)

const

INDIRECT GEOMETRY INSTRUMENTS ONLY : true if a physical instrument was specified, distinct from the neutronic one held by the workspace.

Definition at line 37 of file InstrumentMetadata.cpp.

References m_physicalComponentInfo.

physicalComponentInfo()

const ComponentInfo & Mantid::Geometry::InstrumentMetadata::physicalComponentInfo

(

)

const

INDIRECT GEOMETRY INSTRUMENTS ONLY : the ComponentInfo of the physical instrument.

Throws if there is no physical instrument.

Definition at line 39 of file InstrumentMetadata.cpp.

References m_physicalComponentInfo.

physicalDetectorInfo()

const DetectorInfo & Mantid::Geometry::InstrumentMetadata::physicalDetectorInfo

(

)

const

INDIRECT GEOMETRY INSTRUMENTS ONLY : the DetectorInfo of the physical instrument.

Throws if there is no physical instrument.

Definition at line 46 of file InstrumentMetadata.cpp.

References m_physicalDetectorInfo.

setDefaultView()

void Mantid::Geometry::InstrumentMetadata::setDefaultView

(

const std::string &

defaultView

)

Definition at line 57 of file InstrumentMetadata.cpp.

References defaultView(), and m_defaultView.

setDefaultViewAxis()

void Mantid::Geometry::InstrumentMetadata::setDefaultViewAxis

(

const std::string &

defaultAxis

)

Definition at line 59 of file InstrumentMetadata.cpp.

References defaultAxis(), and m_defaultAxis.

setFileName()

void Mantid::Geometry::InstrumentMetadata::setFileName

(

const std::string &

filename

)

Definition at line 53 of file InstrumentMetadata.cpp.

References filename(), and m_filename.

setXmlText()

void Mantid::Geometry::InstrumentMetadata::setXmlText

(

const std::string &

xmlText

)

Definition at line 55 of file InstrumentMetadata.cpp.

References m_xmlText, and xmlText().

validFromDate()

const Types::Core::DateAndTime & Mantid::Geometry::InstrumentMetadata::validFromDate

(

)

const

Definition at line 25 of file InstrumentMetadata.cpp.

References m_validFromDate.

validToDate()

const Types::Core::DateAndTime & Mantid::Geometry::InstrumentMetadata::validToDate

(

)

const

Definition at line 27 of file InstrumentMetadata.cpp.

References m_validToDate.

xmlText()

const std::string & Mantid::Geometry::InstrumentMetadata::xmlText

(

)

const

Definition at line 31 of file InstrumentMetadata.cpp.

References m_xmlText.

Referenced by setXmlText().

Member Data Documentation

m_defaultAxis

std::string Mantid::Geometry::InstrumentMetadata::m_defaultAxis

private

Definition at line 62 of file InstrumentMetadata.h.

Referenced by defaultAxis(), and setDefaultViewAxis().

m_defaultView

std::string Mantid::Geometry::InstrumentMetadata::m_defaultView

private

Definition at line 61 of file InstrumentMetadata.h.

Referenced by defaultView(), and setDefaultView().

m_filename

std::string Mantid::Geometry::InstrumentMetadata::m_filename

private

Definition at line 59 of file InstrumentMetadata.h.

Referenced by filename(), and setFileName().

m_physicalComponentInfo

std::shared_ptr<const ComponentInfo> Mantid::Geometry::InstrumentMetadata::m_physicalComponentInfo

private

Definition at line 64 of file InstrumentMetadata.h.

Referenced by hasPhysicalInstrument(), and physicalComponentInfo().

m_physicalDetectorInfo

std::shared_ptr<const DetectorInfo> Mantid::Geometry::InstrumentMetadata::m_physicalDetectorInfo

private

Definition at line 65 of file InstrumentMetadata.h.

Referenced by physicalDetectorInfo().

m_validFromDate

Types::Core::DateAndTime Mantid::Geometry::InstrumentMetadata::m_validFromDate

private

Definition at line 57 of file InstrumentMetadata.h.

Referenced by validFromDate().

m_validToDate

Types::Core::DateAndTime Mantid::Geometry::InstrumentMetadata::m_validToDate

private

Definition at line 58 of file InstrumentMetadata.h.

Referenced by validToDate().

m_xmlText

std::string Mantid::Geometry::InstrumentMetadata::m_xmlText

private

Definition at line 60 of file InstrumentMetadata.h.

Referenced by setXmlText(), and xmlText().

---

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

• Framework/Geometry/inc/MantidGeometry/Instrument/InstrumentMetadata.h
• Framework/Geometry/src/Instrument/InstrumentMetadata.cpp