The PInstrument class represents a muon spectrometer instrument. More...

#include <PInstrumentDef.h>

Public Member Functions
	PInstrument ()
	Constructor. Initializes all strings to empty.

	~PInstrument ()
	Destructor.

void	setRunNameTemplate (QString str)
	Sets the run name template for data file naming.

void	setBeamline (QString str)
	Sets the beamline name.

void	setDataFileFormat (QString str)
	Sets the data file format.

void	setInstitue (QString str)
	Sets the institute name.

void	setName (QString str)
	Sets the instrument name.

void	addSetupZF (PSetup zf)
	Adds a zero-field (ZF) setup configuration.

void	addSetupTF (PSetup tf)
	Adds a transverse-field (TF) setup configuration.

void	addSetupLF (PSetup lf)
	Adds a longitudinal-field (LF) setup configuration.

QString	getRunNameTemplate ()
	Returns the run name template.

QString	getBeamline ()
	Returns the beamline name.

QString	getDataFileFormat ()
	Returns the data file format.

QString	getInstitute ()
	Returns the institute name.

QString	getName ()
	Returns the instrument name.

QVector< PSetup >	getZFSetups ()
	Returns all ZF setups.

QVector< PSetup >	getTFSetups ()
	Returns all TF setups.

QVector< PSetup >	getLFSetups ()
	Returns all LF setups.

PSetup *	getZFSetup (QString name="")
	Returns a ZF setup by name.

PSetup *	getTFSetup (QString name="")
	Returns a TF setup by name.

PSetup *	getLFSetup (QString name="")
	Returns a LF setup by name.

Private Attributes
QString	fRunNameTemplate
	template for run file names

QString	fBeamline
	beamline identifier

QString	fDataFileFormat
	data file format

QString	fInstitue
	institute name

QString	fName
	instrument name

QVector< PSetup >	fZF
	zero-field setups

QVector< PSetup >	fTF
	transverse-field setups

QVector< PSetup >	fLF
	longitudinal-field setups

Detailed Description

The PInstrument class represents a muon spectrometer instrument.

This class contains all information about a specific muon instrument including its name, beamline, run name template, data file format, and measurement setups for ZF (zero field), TF (transverse field), and LF (longitudinal field) configurations.

Constructor & Destructor Documentation

◆ PInstrument()

PInstrument::PInstrument ( )

Constructor. Initializes all strings to empty.

PInstrument::PInstrument constructor initializes all strings to empty.

◆ ~PInstrument()

PInstrument::~PInstrument ( )

inline

Destructor.

Member Function Documentation

◆ addSetupLF()

void PInstrument::addSetupLF ( PSetup lf )

inline

Adds a longitudinal-field (LF) setup configuration.

Parameters

lf	Setup object to add.

◆ addSetupTF()

void PInstrument::addSetupTF ( PSetup tf )

inline

Adds a transverse-field (TF) setup configuration.

Parameters

tf	Setup object to add.

◆ addSetupZF()

void PInstrument::addSetupZF ( PSetup zf )

inline

Adds a zero-field (ZF) setup configuration.

Parameters

zf	Setup object to add.

◆ getBeamline()

QString PInstrument::getBeamline ( )

inline

Returns the beamline name.

Returns: Beamline name.

◆ getDataFileFormat()

QString PInstrument::getDataFileFormat ( )

inline

Returns the data file format.

Returns: Data file format string.

◆ getInstitute()

QString PInstrument::getInstitute ( )

inline

Returns the institute name.

Returns: Institute name.

◆ getLFSetup()

PSetup * PInstrument::getLFSetup ( QString name = "" )

Returns a LF setup by name.

PInstrument::getLFSetup returns a longitudinal-field setup by name.

Parameters

name	Setup name (default: first available).

Returns: Pointer to PSetup, or nullptr if not found.

Parameters

name	Setup name to search for. If empty, returns the first available setup.

Returns: Pointer to PSetup, or nullptr if not found.

◆ getLFSetups()

QVector< PSetup > PInstrument::getLFSetups ( )

inline

Returns all LF setups.

Returns: Vector of LF setup configurations.

◆ getName()

QString PInstrument::getName ( )

inline

Returns the instrument name.

Returns: Instrument name.

◆ getRunNameTemplate()

QString PInstrument::getRunNameTemplate ( )

inline

Returns the run name template.

Returns: Run name template string.

◆ getTFSetup()

PSetup * PInstrument::getTFSetup ( QString name = "" )

Returns a TF setup by name.

PInstrument::getTFSetup returns a transverse-field setup by name.

Parameters

name	Setup name (default: first available).

Returns: Pointer to PSetup, or nullptr if not found.

Parameters

name	Setup name to search for. If empty, returns the first available setup.

Returns: Pointer to PSetup, or nullptr if not found.

◆ getTFSetups()

QVector< PSetup > PInstrument::getTFSetups ( )

inline

Returns all TF setups.

Returns: Vector of TF setup configurations.

◆ getZFSetup()

PSetup * PInstrument::getZFSetup ( QString name = "" )

Returns a ZF setup by name.

PInstrument::getZFSetup returns a zero-field setup by name.

Parameters

name	Setup name (default: first available).

Returns: Pointer to PSetup, or nullptr if not found.

Parameters

name	Setup name to search for. If empty, returns the first available setup.

Returns: Pointer to PSetup, or nullptr if not found.

◆ getZFSetups()

QVector< PSetup > PInstrument::getZFSetups ( )

inline

Returns all ZF setups.

Returns: Vector of ZF setup configurations.

◆ setBeamline()

void PInstrument::setBeamline ( QString str )

inline

Sets the beamline name.

Parameters

str	Beamline identifier (e.g., "piM3.2").

◆ setDataFileFormat()

void PInstrument::setDataFileFormat ( QString str )

inline

Sets the data file format.

Parameters

str	File format (e.g., "PsiMdu", "NeXus", "WKM").

◆ setInstitue()

void PInstrument::setInstitue ( QString str )

inline

Sets the institute name.

Parameters

str	Institute name (e.g., "PSI").

◆ setName()

void PInstrument::setName ( QString str )

inline

Sets the instrument name.

Parameters

str	Instrument name (e.g., "GPS", "HAL9500").

◆ setRunNameTemplate()

void PInstrument::setRunNameTemplate ( QString str )

inline

Sets the run name template for data file naming.

Parameters

str	Template string (e.g., "deltat_tdc_gps_[yyyy]_[nnnn].bin").

Member Data Documentation

◆ fBeamline

QString PInstrument::fBeamline

private

beamline identifier

◆ fDataFileFormat

QString PInstrument::fDataFileFormat

private

data file format

◆ fInstitue

QString PInstrument::fInstitue

private

institute name

◆ fLF

QVector<PSetup> PInstrument::fLF

private

longitudinal-field setups

◆ fName

QString PInstrument::fName

private

instrument name

◆ fRunNameTemplate

QString PInstrument::fRunNameTemplate

private

template for run file names

◆ fTF

QVector<PSetup> PInstrument::fTF

private

transverse-field setups

◆ fZF

QVector<PSetup> PInstrument::fZF

private

zero-field setups

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

/workspace/LMU/musrfit/src/musredit_qt6/musrWiz/PInstrumentDef.h
/workspace/LMU/musrfit/src/musredit_qt6/musrWiz/PInstrumentDef.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PInstrument()

◆ ~PInstrument()

Member Function Documentation

◆ addSetupLF()

◆ addSetupTF()

◆ addSetupZF()

◆ getBeamline()

◆ getDataFileFormat()

◆ getInstitute()

◆ getLFSetup()

◆ getLFSetups()

◆ getName()

◆ getRunNameTemplate()

◆ getTFSetup()

◆ getTFSetups()

◆ getZFSetup()

◆ getZFSetups()

◆ setBeamline()

◆ setDataFileFormat()

◆ setInstitue()

◆ setName()

◆ setRunNameTemplate()

Member Data Documentation

◆ fBeamline

◆ fDataFileFormat

◆ fInstitue

◆ fLF

◆ fName

◆ fRunNameTemplate

◆ fTF

◆ fZF