InstrumentItem Class Reference

Description

Abstract base class for instrument-specific item classes.

Definition at line 41 of file InstrumentItems.h.

Inheritance diagram for InstrumentItem:

Collaboration diagram for InstrumentItem:

Public Member Functions
	InstrumentItem ()
virtual	~InstrumentItem ()=default
virtual bool	alignedWith (const RealDataItem *item) const
BackgroundItem *	backgroundItem () const
SelectionDescriptor< BackgroundItem * >	backgroundSelection () const
virtual BeamItem *	beamItem () const
virtual ICoordSystem *	createCoordSystem () const =0
InstrumentItem *	createCopy () const
	Creates an exact copy; also ID is the same! More...
virtual QString	defaultName () const =0
	The default user visible name when creating an instrument. More...
QString	description () const
	DOUBLE_PROPERTY (analyzerTotalTransmission, AnalyzerTotalTransmission)
QString	id () const
virtual void	importMasks (const MaskContainerItem *)
QString	instrumentName () const
virtual QString	instrumentType () const =0
	The type as how to show it on the UI. Do not use for type checking or similar! More...
template<typename T >
bool	is () const
virtual void	serialize (Streamer &s)
template<typename T >
T *	setBackgroundType ()
void	setDescription (const QString &description)
void	setId (const QString &id)
void	setInstrumentName (const QString &instrumentName)
void	setWithPolarizerAnalyzer (bool with)
virtual std::vector< int >	shape () const =0
virtual void	updateToRealData (const RealDataItem *item)=0
	VECTOR_PROPERTY (analyzerDirection, AnalyzerDirection)
	VECTOR_PROPERTY (polarization, Polarization)
bool	withPolarizerAnalyzer () const

Protected Member Functions
	InstrumentItem (const QString &modelType)
template<typename T >
T *	beam () const

Protected Attributes
SelectionProperty< BackgroundItem * >	m_backgroundItem
std::unique_ptr< BeamItem >	m_beamItem
QString	m_description
QString	m_id
QString	m_name
bool	m_withPolarizerAnalyzer

Constructor & Destructor Documentation

InstrumentItem() [1/2]

InstrumentItem::InstrumentItem

(

)

Definition at line 59 of file InstrumentItems.cpp.

    : m_withPolarizerAnalyzer(false)
{
    m_id = QUuid::createUuid().toString();
    m_analyzerEfficiency.init("Analyzer efficiency", "Efficiency of the polarization analysis", 0.0,
                              Unit::unitless, 4, RealLimits::limitless(), "efficiency");
    m_analyzerTotalTransmission.init("Analyzer transmission",
                                     "Total transmission of the polarization analysis", 1.0,
                                     Unit::unitless, 4, RealLimits::nonnegative(), "transmission");
    m_polarization.init("Polarization (Bloch vector)",
                        "Polarization of the beam, given as the Bloch vector", Unit::unitless,
                        "polarization");
    m_analyzerDirection.init("Analyzer direction", "Direction of the polarization analysis",
                             Unit::unitless, "analyzerDirection");
    m_backgroundItem.init<BackgroundItemCatalog>("Background", "", "background");
}

References SelectionProperty< T >::init(), m_backgroundItem, m_id, and unitless.

Here is the call graph for this function:

~InstrumentItem()

virtual InstrumentItem::~InstrumentItem ( )

virtualdefault

InstrumentItem() [2/2]

InstrumentItem::InstrumentItem ( const QString &  modelType )

explicitprotected

Member Function Documentation

alignedWith()

bool InstrumentItem::alignedWith ( const RealDataItem *  item ) const

virtual

Reimplemented in SpecularInstrumentItem.

Definition at line 129 of file InstrumentItems.cpp.

{
    return shape() == item->shape();
}

References RealDataItem::shape(), and shape().

Referenced by LinkInstrumentManager::onInstrumentChanged(), and SimulationView::validateSimulationSetup().

Here is the call graph for this function:

backgroundItem()

BackgroundItem * InstrumentItem::backgroundItem

(

)

const

Definition at line 119 of file InstrumentItems.cpp.

{
    return m_backgroundItem.get();
}

References SelectionProperty< T >::get(), and m_backgroundItem.

Here is the call graph for this function:

backgroundSelection()

SelectionDescriptor< BackgroundItem * > InstrumentItem::backgroundSelection

(

)

const

Definition at line 124 of file InstrumentItems.cpp.

{
    return m_backgroundItem;
}

References m_backgroundItem.

Referenced by EnvironmentEditor::EnvironmentEditor(), and EnvironmentEditor::createBackgroundWidgets().

beam()

template<typename T >

T * InstrumentItem::beam

protected

Definition at line 145 of file InstrumentItems.cpp.

{
    return dynamic_cast<T*>(m_beamItem.get());
}

References m_beamItem.

Referenced by SpecularInstrumentItem::createCoordSystem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), and Instrument2DItem::createScatteringSimulation().

beamItem()

BeamItem * InstrumentItem::beamItem ( ) const

virtual

Reimplemented in DepthProbeInstrumentItem, and SpecularInstrumentItem.

Definition at line 114 of file InstrumentItems.cpp.

{
    return m_beamItem.get();
}

References m_beamItem.

Referenced by GISASInstrumentEditor::GISASInstrumentEditor(), OffspecBeamEditor::OffspecBeamEditor(), OffspecInstrumentItem::OffspecInstrumentItem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), Instrument2DItem::createScatteringSimulation(), InstrumentEditController::notifyInclinationAxisChanged(), and InstrumentEditController::notifyWavelengthDistributionChanged().

createCoordSystem()

virtual ICoordSystem* InstrumentItem::createCoordSystem ( ) const

pure virtual

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by GUI::Model::JobItemUtils::createDefaultDetectorMap(), GUI::Model::JobFunctions::initDataView(), GUI::Model::JobItemUtils::setIntensityItemCoords(), and GUI::Model::JobItemUtils::updateDataAxes().

createCopy()

InstrumentItem * InstrumentItem::createCopy

(

)

const

Creates an exact copy; also ID is the same!

Definition at line 76 of file InstrumentItems.cpp.

{
    const auto type = InstrumentItemCatalog::type(this);
    auto* copy = InstrumentItemCatalog::create(type);
    GUI::Util::copyContents(this, copy);
    return copy;
}

References GUI::Util::copyContents(), InstrumentItemCatalog::create(), and InstrumentItemCatalog::type().

Referenced by JobItem::copyInstrumentIntoJob(), and InstrumentCollection::insertCopy().

Here is the call graph for this function:

defaultName()

virtual QString InstrumentItem::defaultName ( ) const

pure virtual

The default user visible name when creating an instrument.

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

description()

QString InstrumentItem::description

(

)

const

Definition at line 104 of file InstrumentItems.cpp.

{
    return m_description;
}

References m_description.

Referenced by setDescription().

DOUBLE_PROPERTY()

InstrumentItem::DOUBLE_PROPERTY	(	analyzerTotalTransmission	,
		AnalyzerTotalTransmission
	)

id()

QString InstrumentItem::id

(

)

const

Definition at line 84 of file InstrumentItems.cpp.

{
    return m_id;
}

References m_id.

Referenced by RealDataItem::linkToInstrument(), LinkInstrumentManager::onInstrumentChanged(), and setId().

importMasks()

virtual void InstrumentItem::importMasks ( const MaskContainerItem *  )

inlinevirtual

Reimplemented in Instrument2DItem.

Definition at line 78 of file InstrumentItems.h.

{}

instrumentName()

QString InstrumentItem::instrumentName

(

)

const

Definition at line 99 of file InstrumentItems.cpp.

{
    return m_name;
}

References m_name.

Referenced by InstrumentListModel::copyInstrument(), InstrumentListModel::data(), InstrumentLibraryEditor::execAdd(), setInstrumentName(), InstrumentsEditController::setInstrumentName(), and GUI::Model::JobFunctions::setupJobItemInstrument().

instrumentType()

virtual QString InstrumentItem::instrumentType ( ) const

pure virtual

The type as how to show it on the UI. Do not use for type checking or similar!

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

is()

template<typename T >

bool InstrumentItem::is ( ) const

inline

Definition at line 61 of file InstrumentItems.h.

    {
        return dynamic_cast<const T*>(this) != nullptr;
    }

Referenced by JobResultsPresenter::defaultActivePresentationsOfInstrument(), JobResultsPresenter::defaultPresentationOfInstrument(), JobResultsPresenter::fitPresentationOfInstrument(), GUI::Model::JobFunctions::initDataView(), InstrumentsTreeModel::instrumentType(), JobItem::isSpecularJob(), GUI::Model::JobFunctions::setupJobItemForFit(), and GUI::Model::JobFunctions::setupJobItemOutput().

serialize()

void InstrumentItem::serialize ( Streamer &  s )

virtual

Reimplemented in OffspecInstrumentItem, Instrument2DItem, and DepthProbeInstrumentItem.

Definition at line 150 of file InstrumentItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwValue(s, "id", m_id);
    Serialize::rwValue(s, "name", m_name);
    Serialize::rwValue(s, "description", m_description);
    Serialize::rwValue(s, "pa", m_withPolarizerAnalyzer);
    Serialize::rwProperty(s, m_polarization);
    Serialize::rwProperty(s, m_analyzerDirection);
    Serialize::rwProperty(s, m_analyzerEfficiency);
    Serialize::rwProperty(s, m_analyzerTotalTransmission);
    Serialize::rwSelected<BackgroundItemCatalog>(s, m_backgroundItem);
    Serialize::rwClass(s, "beam", *m_beamItem);
}

References Streamer::assertVersion(), m_backgroundItem, m_beamItem, m_description, m_id, m_name, m_withPolarizerAnalyzer, Serialize::rwClass(), Serialize::rwProperty(), and Serialize::rwValue().

Here is the call graph for this function:

setBackgroundType()

template<typename T >

T * InstrumentItem::setBackgroundType

Definition at line 205 of file InstrumentItems.h.

{
    m_backgroundItem.set<T>();
    return dynamic_cast<T*>(m_backgroundItem.get());
}

References SelectionProperty< T >::get(), m_backgroundItem, and SelectionProperty< T >::set().

Here is the call graph for this function:

setDescription()

void InstrumentItem::setDescription

(

const QString &

description

)

Definition at line 109 of file InstrumentItems.cpp.

{
    m_description = description;
}

References description(), and m_description.

Referenced by InstrumentView::onInstrumentdescriptionEdited(), and InstrumentsTreeModel::setData().

Here is the call graph for this function:

setId()

void InstrumentItem::setId

(

const QString &

id

)

Definition at line 89 of file InstrumentItems.cpp.

{
    m_id = id;
}

References id(), and m_id.

Referenced by InstrumentCollection::insertCopy().

Here is the call graph for this function:

setInstrumentName()

void InstrumentItem::setInstrumentName

(

const QString &

instrumentName

)

Definition at line 94 of file InstrumentItems.cpp.

{
    m_name = instrumentName;
}

References instrumentName(), and m_name.

Referenced by InstrumentsEditController::addCopy(), InstrumentsTreeModel::setData(), InstrumentsEditController::setInstrumentName(), and GUI::Model::JobFunctions::setupJobItemInstrument().

Here is the call graph for this function:

setWithPolarizerAnalyzer()

void InstrumentItem::setWithPolarizerAnalyzer

(

bool

with

)

Definition at line 139 of file InstrumentItems.cpp.

{
    m_withPolarizerAnalyzer = with;
}

References m_withPolarizerAnalyzer.

Referenced by PolarizationAnalysisEditor::PolarizationAnalysisEditor().

shape()

virtual std::vector<int> InstrumentItem::shape ( ) const

pure virtual

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by alignedWith().

updateToRealData()

virtual void InstrumentItem::updateToRealData ( const RealDataItem *  item )

pure virtual

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by InstrumentsEditController::updateInstrumentToRealDataItem().

VECTOR_PROPERTY() [1/2]

InstrumentItem::VECTOR_PROPERTY	(	analyzerDirection	,
		AnalyzerDirection
	)

VECTOR_PROPERTY() [2/2]

InstrumentItem::VECTOR_PROPERTY	(	polarization	,
		Polarization
	)

withPolarizerAnalyzer()

bool InstrumentItem::withPolarizerAnalyzer

(

)

const

Definition at line 134 of file InstrumentItems.cpp.

{
    return m_withPolarizerAnalyzer;
}

References m_withPolarizerAnalyzer.

Referenced by PolarizationAnalysisEditor::PolarizationAnalysisEditor(), and ParameterTreeBuilder::addPolarization().

Member Data Documentation

m_backgroundItem

SelectionProperty<BackgroundItem*> InstrumentItem::m_backgroundItem

protected

Definition at line 106 of file InstrumentItems.h.

Referenced by InstrumentItem(), backgroundItem(), backgroundSelection(), serialize(), and setBackgroundType().

m_beamItem

std::unique_ptr<BeamItem> InstrumentItem::m_beamItem

protected

Definition at line 107 of file InstrumentItems.h.

Referenced by DepthProbeInstrumentItem::DepthProbeInstrumentItem(), Instrument2DItem::Instrument2DItem(), SpecularInstrumentItem::SpecularInstrumentItem(), beam(), beamItem(), and serialize().

m_description

QString InstrumentItem::m_description

protected

Definition at line 104 of file InstrumentItems.h.

Referenced by description(), serialize(), and setDescription().

m_id

QString InstrumentItem::m_id

protected

Definition at line 102 of file InstrumentItems.h.

Referenced by InstrumentItem(), id(), serialize(), and setId().

m_name

QString InstrumentItem::m_name

protected

Definition at line 103 of file InstrumentItems.h.

Referenced by instrumentName(), serialize(), and setInstrumentName().

m_withPolarizerAnalyzer

bool InstrumentItem::m_withPolarizerAnalyzer

protected

Definition at line 105 of file InstrumentItems.h.

Referenced by serialize(), setWithPolarizerAnalyzer(), and withPolarizerAnalyzer().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentItems.cpp