SimulationOptionsItem Class Reference

Description

The SimulationOptionsItem class holds simulation status (run policy, number of threads, integration flag). Used in SimulationView to define job settings. When job is started, item is copied to the job.

Definition at line 25 of file SimulationOptionsItem.h.

Public Member Functions
	SimulationOptionsItem ()
bool	includeSpecularPeak () const
unsigned	numberOfMonteCarloPoints () const
unsigned	numberOfThreads () const
void	readContentFrom (QXmlStreamReader *reader)
bool	runImmediately () const
bool	runInBackground () const
void	setIncludeSpecularPeak (bool includeSpecularPeak)
void	setNumberOfThreads (unsigned n)
void	setRunImmediately (bool runImmediately)
void	setUseAnalytical ()
void	setUseAverageMaterials (bool useAverageMaterials)
void	setUseMonteCarloIntegration (unsigned numberOfPoints)
bool	useAnalytical () const
bool	useAverageMaterials () const
bool	useMonteCarloIntegration () const
void	writeContentTo (QXmlStreamWriter *writer) const

Private Attributes
bool	m_computationMethodAnalytical
bool	m_includeSpecularPeak
unsigned	m_numberOfMonteCarloPoints
unsigned	m_numberOfThreads
bool	m_runImmediately
bool	m_useAverageMaterials

Constructor & Destructor Documentation

SimulationOptionsItem()

SimulationOptionsItem::SimulationOptionsItem ( )

explicit

Definition at line 37 of file SimulationOptionsItem.cpp.

{
    m_runImmediately = true;
    m_numberOfThreads = std::thread::hardware_concurrency();
    m_computationMethodAnalytical = true;
    m_numberOfMonteCarloPoints = 100;
    m_useAverageMaterials = false;
    m_includeSpecularPeak = false;
}

References m_computationMethodAnalytical, m_includeSpecularPeak, m_numberOfMonteCarloPoints, m_numberOfThreads, m_runImmediately, and m_useAverageMaterials.

Member Function Documentation

includeSpecularPeak()

bool SimulationOptionsItem::includeSpecularPeak

(

)

const

Definition at line 113 of file SimulationOptionsItem.cpp.

{
    return m_includeSpecularPeak;
}

References m_includeSpecularPeak.

Referenced by setIncludeSpecularPeak().

numberOfMonteCarloPoints()

unsigned SimulationOptionsItem::numberOfMonteCarloPoints

(

)

const

Definition at line 93 of file SimulationOptionsItem.cpp.

{
    return m_numberOfMonteCarloPoints;
}

References m_numberOfMonteCarloPoints.

numberOfThreads()

unsigned SimulationOptionsItem::numberOfThreads

(

)

const

Definition at line 47 of file SimulationOptionsItem.cpp.

{
    return m_numberOfThreads;
}

References m_numberOfThreads.

readContentFrom()

void SimulationOptionsItem::readContentFrom

(

QXmlStreamReader *

reader

)

Definition at line 130 of file SimulationOptionsItem.cpp.

{
    const int version = reader->attributes().value(GUI::Session::XML::Version).toInt();
 
    if (version < 1)
        throw DeserializationException::tooOld();
 
    if (version > 1)
        throw DeserializationException::tooNew();
 
    m_runImmediately = GUI::Session::XML::readBoolAttribute(reader, Tags::RunImmediately);
    m_numberOfThreads = GUI::Session::XML::readUIntAttribute(reader, Tags::NumberOfThreads);
    m_computationMethodAnalytical = GUI::Session::XML::readBoolAttribute(reader, Tags::Analytical);
    m_numberOfMonteCarloPoints =
        GUI::Session::XML::readUIntAttribute(reader, Tags::NumberOfMonteCarloPoints);
    m_useAverageMaterials = GUI::Session::XML::readBoolAttribute(reader, Tags::UseAverageMaterials);
    m_includeSpecularPeak = GUI::Session::XML::readBoolAttribute(reader, Tags::IncludeSpecularPeak);
}

References m_computationMethodAnalytical, m_includeSpecularPeak, m_numberOfMonteCarloPoints, m_numberOfThreads, m_runImmediately, m_useAverageMaterials, GUI::Session::XML::readBoolAttribute(), GUI::Session::XML::readUIntAttribute(), DeserializationException::tooNew(), DeserializationException::tooOld(), and GUI::Session::XML::Version().

Referenced by JobItem::readNonSessionItems(), and ProjectDocument::readProject().

Here is the call graph for this function:

runImmediately()

bool SimulationOptionsItem::runImmediately

(

)

const

Definition at line 57 of file SimulationOptionsItem.cpp.

{
    return m_runImmediately;
}

References m_runImmediately.

Referenced by JobItem::runImmediately(), runInBackground(), setRunImmediately(), and SimulationView::writeOptionsToUI().

runInBackground()

bool SimulationOptionsItem::runInBackground

(

)

const

Definition at line 62 of file SimulationOptionsItem.cpp.

{
    return !runImmediately();
}

References runImmediately().

Referenced by JobItem::runInBackground().

Here is the call graph for this function:

setIncludeSpecularPeak()

void SimulationOptionsItem::setIncludeSpecularPeak

(

bool

includeSpecularPeak

)

Definition at line 108 of file SimulationOptionsItem.cpp.

{
    m_includeSpecularPeak = includeSpecularPeak;
}

References includeSpecularPeak(), and m_includeSpecularPeak.

Referenced by SimulationView::readOptionsFromUI().

Here is the call graph for this function:

setNumberOfThreads()

void SimulationOptionsItem::setNumberOfThreads

(

unsigned

n

)

Definition at line 52 of file SimulationOptionsItem.cpp.

{
    m_numberOfThreads = number;
}

References m_numberOfThreads.

Referenced by SimulationView::readOptionsFromUI().

setRunImmediately()

void SimulationOptionsItem::setRunImmediately

(

bool

runImmediately

)

Definition at line 67 of file SimulationOptionsItem.cpp.

{
    m_runImmediately = runImmediately;
}

References m_runImmediately, and runImmediately().

Referenced by SimulationView::readOptionsFromUI().

Here is the call graph for this function:

setUseAnalytical()

void SimulationOptionsItem::setUseAnalytical

(

)

Definition at line 78 of file SimulationOptionsItem.cpp.

{
    m_computationMethodAnalytical = true;
}

References m_computationMethodAnalytical.

Referenced by SimulationView::readOptionsFromUI().

setUseAverageMaterials()

void SimulationOptionsItem::setUseAverageMaterials

(

bool

useAverageMaterials

)

Definition at line 98 of file SimulationOptionsItem.cpp.

{
    m_useAverageMaterials = useAverageMaterials;
}

References m_useAverageMaterials, and useAverageMaterials().

Referenced by SimulationView::readOptionsFromUI().

Here is the call graph for this function:

setUseMonteCarloIntegration()

void SimulationOptionsItem::setUseMonteCarloIntegration

(

unsigned

numberOfPoints

)

Definition at line 72 of file SimulationOptionsItem.cpp.

{
    m_computationMethodAnalytical = false;
    m_numberOfMonteCarloPoints = numberOfPoints;
}

References m_computationMethodAnalytical, and m_numberOfMonteCarloPoints.

Referenced by GUI::Transform::FromCore::itemizeOptions(), and SimulationView::readOptionsFromUI().

useAnalytical()

bool SimulationOptionsItem::useAnalytical

(

)

const

Definition at line 88 of file SimulationOptionsItem.cpp.

{
    return m_computationMethodAnalytical;
}

References m_computationMethodAnalytical.

Referenced by useMonteCarloIntegration(), and SimulationView::writeOptionsToUI().

useAverageMaterials()

bool SimulationOptionsItem::useAverageMaterials

(

)

const

Definition at line 103 of file SimulationOptionsItem.cpp.

{
    return m_useAverageMaterials;
}

References m_useAverageMaterials.

Referenced by setUseAverageMaterials(), and SimulationView::writeOptionsToUI().

useMonteCarloIntegration()

bool SimulationOptionsItem::useMonteCarloIntegration

(

)

const

Definition at line 83 of file SimulationOptionsItem.cpp.

{
    return !useAnalytical();
}

References useAnalytical().

Here is the call graph for this function:

writeContentTo()

void SimulationOptionsItem::writeContentTo

(

QXmlStreamWriter *

writer

)

const

Definition at line 118 of file SimulationOptionsItem.cpp.

{
    GUI::Session::XML::writeAttribute(writer, GUI::Session::XML::Version, int(1));
    GUI::Session::XML::writeAttribute(writer, Tags::RunImmediately, m_runImmediately);
    GUI::Session::XML::writeAttribute(writer, Tags::NumberOfThreads, m_numberOfThreads);
    GUI::Session::XML::writeAttribute(writer, Tags::Analytical, m_computationMethodAnalytical);
    GUI::Session::XML::writeAttribute(writer, Tags::NumberOfMonteCarloPoints,
                                      m_numberOfMonteCarloPoints);
    GUI::Session::XML::writeAttribute(writer, Tags::UseAverageMaterials, m_useAverageMaterials);
    GUI::Session::XML::writeAttribute(writer, Tags::IncludeSpecularPeak, m_includeSpecularPeak);
}

References m_computationMethodAnalytical, m_includeSpecularPeak, m_numberOfMonteCarloPoints, m_numberOfThreads, m_runImmediately, m_useAverageMaterials, GUI::Session::XML::Version(), and GUI::Session::XML::writeAttribute().

Referenced by JobItem::writeNonSessionItems(), and ProjectDocument::writeTo().

Here is the call graph for this function:

Member Data Documentation

m_computationMethodAnalytical

bool SimulationOptionsItem::m_computationMethodAnalytical

private

Definition at line 55 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), readContentFrom(), setUseAnalytical(), setUseMonteCarloIntegration(), useAnalytical(), and writeContentTo().

m_includeSpecularPeak

bool SimulationOptionsItem::m_includeSpecularPeak

private

Definition at line 58 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), includeSpecularPeak(), readContentFrom(), setIncludeSpecularPeak(), and writeContentTo().

m_numberOfMonteCarloPoints

unsigned SimulationOptionsItem::m_numberOfMonteCarloPoints

private

Definition at line 56 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), numberOfMonteCarloPoints(), readContentFrom(), setUseMonteCarloIntegration(), and writeContentTo().

m_numberOfThreads

unsigned SimulationOptionsItem::m_numberOfThreads

private

Definition at line 54 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), numberOfThreads(), readContentFrom(), setNumberOfThreads(), and writeContentTo().

m_runImmediately

bool SimulationOptionsItem::m_runImmediately

private

Definition at line 53 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), readContentFrom(), runImmediately(), setRunImmediately(), and writeContentTo().

m_useAverageMaterials

bool SimulationOptionsItem::m_useAverageMaterials

private

Definition at line 57 of file SimulationOptionsItem.h.

Referenced by SimulationOptionsItem(), readContentFrom(), setUseAverageMaterials(), useAverageMaterials(), and writeContentTo().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/SimulationOptionsItem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/Data/SimulationOptionsItem.cpp