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
	InstrumentMetadata (const Types::Core::DateAndTime &validFromDate, const Types::Core::DateAndTime &validToDate, std::string filename, std::string xmlText, std::string defaultView, std::string defaultAxis, Instrument_const_sptr physicalInstrument)
Instrument_const_sptr	physicalInstrument () const
	INDIRECT GEOMETRY INSTRUMENTS ONLY : the physical instrument, if one was specified.
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
Instrument_const_sptr	m_physicalInstrument
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 and read-only thereafter.

Definition at line 25 of file InstrumentMetadata.h.

Constructor & Destructor Documentation

InstrumentMetadata()

Mantid::Geometry::InstrumentMetadata::InstrumentMetadata	(	const Types::Core::DateAndTime &	validFromDate,
		const Types::Core::DateAndTime &	validToDate,
		std::string	filename,
		std::string	xmlText,
		std::string	defaultView,
		std::string	defaultAxis,
		Instrument_const_sptr	physicalInstrument
	)

Definition at line 11 of file InstrumentMetadata.cpp.

Member Function Documentation

defaultAxis()

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

(

)

const

Definition at line 29 of file InstrumentMetadata.cpp.

References m_defaultAxis.

defaultView()

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

(

)

const

Definition at line 27 of file InstrumentMetadata.cpp.

References m_defaultView.

filename()

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

(

)

const

Definition at line 23 of file InstrumentMetadata.cpp.

References m_filename.

physicalInstrument()

Instrument_const_sptr Mantid::Geometry::InstrumentMetadata::physicalInstrument

(

)

const

INDIRECT GEOMETRY INSTRUMENTS ONLY : the physical instrument, if one was specified.

This is a legacy Instrument 1.0 object. Replacing it needs its own nested ComponentInfo/DetectorInfo design (tracked separately).

Definition at line 31 of file InstrumentMetadata.cpp.

References m_physicalInstrument.

validFromDate()

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

(

)

const

Definition at line 19 of file InstrumentMetadata.cpp.

References m_validFromDate.

validToDate()

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

(

)

const

Definition at line 21 of file InstrumentMetadata.cpp.

References m_validToDate.

xmlText()

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

(

)

const

Definition at line 25 of file InstrumentMetadata.cpp.

References m_xmlText.

Member Data Documentation

m_defaultAxis

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

private

Definition at line 48 of file InstrumentMetadata.h.

Referenced by defaultAxis().

m_defaultView

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

private

Definition at line 47 of file InstrumentMetadata.h.

Referenced by defaultView().

m_filename

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

private

Definition at line 45 of file InstrumentMetadata.h.

Referenced by filename().

m_physicalInstrument

Instrument_const_sptr Mantid::Geometry::InstrumentMetadata::m_physicalInstrument

private

Definition at line 49 of file InstrumentMetadata.h.

Referenced by physicalInstrument().

m_validFromDate

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

private

Definition at line 43 of file InstrumentMetadata.h.

Referenced by validFromDate().

m_validToDate

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

private

Definition at line 44 of file InstrumentMetadata.h.

Referenced by validToDate().

m_xmlText

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

private

Definition at line 46 of file InstrumentMetadata.h.

Referenced by 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