PmuppCollection Class Reference

Represents a collection of related experimental runs. More...

#include <Pmupp.h>

Public Member Functions
	PmuppCollection ()
	Default constructor. Initializes an empty collection.
void	SetPathName (QString pathName)
	Sets the full path name of the collection file.
void	SetName (QString name)
	Sets the collection name.
void	AddRun (PmuppRun run)
	Adds a run to this collection.
QString	GetPathName ()
	Gets the full path name of the collection file.
QString	GetName ()
	Gets the collection name.
int	GetNoOfRuns ()
	Gets the number of runs in this collection.
PmuppRun	GetRun (unsigned int idx)
	Retrieves a run from a collection by index.

Private Attributes
QString	fPathName
	full path and filename of the collection data file
QString	fName
	display name of the collection (usually just the filename)
QVector< PmuppRun >	fRun
	vector of all runs in this collection

Detailed Description

Represents a collection of related experimental runs.

The PmuppCollection class groups together multiple runs that form a coherent dataset, typically representing a scan over some experimental parameter such as temperature, magnetic field, energy, pressure, etc.

A collection corresponds to a single data file (db, dat, or msr format) and contains all runs from that file. This is the top level in the data hierarchy: Parameter -> Run -> Collection

Example use cases:

• Temperature scan: multiple runs at different temperatures
• Field scan: runs at various magnetic field values
• Energy scan: runs at different implantation energies

Definition at line 234 of file Pmupp.h.

Constructor & Destructor Documentation

PmuppCollection()

PmuppCollection::PmuppCollection ( )

inline

Default constructor. Initializes an empty collection.

Definition at line 239 of file Pmupp.h.

Member Function Documentation

AddRun()

void PmuppCollection::AddRun ( PmuppRun run )

inline

Adds a run to this collection.

Parameters

run	the PmuppRun object to be added to the run list

Definition at line 257 of file Pmupp.h.

GetName()

QString PmuppCollection::GetName ( )

inline

Gets the collection name.

Returns

the collection name string

Definition at line 269 of file Pmupp.h.

GetNoOfRuns()

int PmuppCollection::GetNoOfRuns ( )

inline

Gets the number of runs in this collection.

Returns

the count of runs stored in this collection

Definition at line 275 of file Pmupp.h.

GetPathName()

QString PmuppCollection::GetPathName ( )

inline

Gets the full path name of the collection file.

Returns

the path name string

Definition at line 263 of file Pmupp.h.

GetRun()

PmuppRun PmuppCollection::GetRun

(

unsigned int

idx

)

Retrieves a run from a collection by index.

Returns a copy of the run at the specified index. If the index is out of range, returns an empty (default-constructed) run.

Parameters

idx	zero-based index of the run to retrieve

Returns

the run at the specified index, or an empty run if out of range

Definition at line 204 of file Pmupp.cpp.

SetName()

void PmuppCollection::SetName ( QString name )

inline

Sets the collection name.

Parameters

name	the display name for this collection

Definition at line 251 of file Pmupp.h.

SetPathName()

void PmuppCollection::SetPathName ( QString pathName )

inline

Sets the full path name of the collection file.

Parameters

pathName

the absolute or relative path to the collection file

Definition at line 245 of file Pmupp.h.

Member Data Documentation

fName

QString PmuppCollection::fName

private

display name of the collection (usually just the filename)

Definition at line 281 of file Pmupp.h.

fPathName

QString PmuppCollection::fPathName

private

full path and filename of the collection data file

Definition at line 280 of file Pmupp.h.

fRun

QVector<PmuppRun> PmuppCollection::fRun

private

vector of all runs in this collection

Definition at line 282 of file Pmupp.h.

---

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

• /workspace/LMU/musrfit/src/musredit_qt6/mupp/Pmupp.h
• /workspace/LMU/musrfit/src/musredit_qt6/mupp/Pmupp.cpp