mitk::pa::MonteCarloThreadHandler Class Reference

The PhotoacousticStatefulObject class Designed for inheritence. Provides a state member variable and convenience methods to check for the state. More...

#include <mitkPAMonteCarloThreadHandler.h>

Inheritance diagram for mitk::pa::MonteCarloThreadHandler:

Collaboration diagram for mitk::pa::MonteCarloThreadHandler:

Public Member Functions
	mitkClassMacroItkParent (MonteCarloThreadHandler, itk::LightObject)
	mitkNewMacro2Param (MonteCarloThreadHandler, long, bool)
	mitkNewMacro3Param (MonteCarloThreadHandler, long, bool, bool)
long	GetNextWorkPackage ()
void	SetPackageSize (long sizeInMilliseconsOrNumberOfPhotons)
virtual long	GetNumberPhotonsToSimulate ()
virtual long	GetNumberPhotonsRemaining ()
virtual long	GetWorkPackageSize ()
virtual long	GetSimulationTime ()
virtual bool	GetSimulateOnTimeBasis ()
virtual bool	GetVerbose ()

Protected Member Functions
	MonteCarloThreadHandler (long timInMilliseconsOrNumberofPhotons, bool simulateOnTimeBasis)
	PhotoacousticThreadhandler. More...
	MonteCarloThreadHandler (long timInMilliseconsOrNumberofPhotons, bool simulateOnTimeBasis, bool verbose)
	PhotoacousticThreadhandler. More...
	~MonteCarloThreadHandler () override

Protected Attributes
long	m_NumberPhotonsToSimulate
long	m_NumberPhotonsRemaining
long	m_WorkPackageSize
long	m_SimulationTime
long	m_Time
bool	m_SimulateOnTimeBasis
bool	m_Verbose
std::mutex	m_MutexRemainingPhotonsManipulation

Detailed Description

The PhotoacousticStatefulObject class Designed for inheritence. Provides a state member variable and convenience methods to check for the state.

Definition at line 31 of file mitkPAMonteCarloThreadHandler.h.

Constructor & Destructor Documentation

MonteCarloThreadHandler() [1/2]

mitk::pa::MonteCarloThreadHandler::MonteCarloThreadHandler ( long  timInMilliseconsOrNumberofPhotons, bool  simulateOnTimeBasis  )

protected

PhotoacousticThreadhandler.

Parameters

timInMilliseconsOrNumberofPhotons
simulateOnTimeBasis

Definition at line 16 of file mitkPAMonteCarloThreadHandler.cpp.

MonteCarloThreadHandler() [2/2]

mitk::pa::MonteCarloThreadHandler::MonteCarloThreadHandler ( long  timInMilliseconsOrNumberofPhotons, bool  simulateOnTimeBasis, bool  verbose  )

protected

PhotoacousticThreadhandler.

Parameters

timInMilliseconsOrNumberofPhotons
simulateOnTimeBasis
verbose

Definition at line 19 of file mitkPAMonteCarloThreadHandler.cpp.

References m_NumberPhotonsRemaining, m_NumberPhotonsToSimulate, m_SimulateOnTimeBasis, m_SimulationTime, m_Time, m_Verbose, m_WorkPackageSize, and verbose().

~MonteCarloThreadHandler()

mitk::pa::MonteCarloThreadHandler::~MonteCarloThreadHandler ( )

overrideprotected

Definition at line 41 of file mitkPAMonteCarloThreadHandler.cpp.

Member Function Documentation

GetNextWorkPackage()

long mitk::pa::MonteCarloThreadHandler::GetNextWorkPackage

(

)

Definition at line 45 of file mitkPAMonteCarloThreadHandler.cpp.

References m_MutexRemainingPhotonsManipulation, m_NumberPhotonsRemaining, m_NumberPhotonsToSimulate, m_SimulateOnTimeBasis, m_SimulationTime, m_Time, m_Verbose, and m_WorkPackageSize.

GetNumberPhotonsRemaining()

virtual long mitk::pa::MonteCarloThreadHandler::GetNumberPhotonsRemaining ( )

virtual

GetNumberPhotonsToSimulate()

virtual long mitk::pa::MonteCarloThreadHandler::GetNumberPhotonsToSimulate ( )

virtual

GetSimulateOnTimeBasis()

virtual bool mitk::pa::MonteCarloThreadHandler::GetSimulateOnTimeBasis ( )

virtual

GetSimulationTime()

virtual long mitk::pa::MonteCarloThreadHandler::GetSimulationTime ( )

virtual

GetVerbose()

virtual bool mitk::pa::MonteCarloThreadHandler::GetVerbose ( )

virtual

GetWorkPackageSize()

virtual long mitk::pa::MonteCarloThreadHandler::GetWorkPackageSize ( )

virtual

mitkClassMacroItkParent()

mitk::pa::MonteCarloThreadHandler::mitkClassMacroItkParent	(	MonteCarloThreadHandler	,
		itk::LightObject
	)

mitkNewMacro2Param()

mitk::pa::MonteCarloThreadHandler::mitkNewMacro2Param	(	MonteCarloThreadHandler	,
		long	,
		bool
	)

mitkNewMacro3Param()

mitk::pa::MonteCarloThreadHandler::mitkNewMacro3Param	(	MonteCarloThreadHandler	,
		long	,
		bool	,
		bool
	)

SetPackageSize()

void mitk::pa::MonteCarloThreadHandler::SetPackageSize

(

long

sizeInMilliseconsOrNumberOfPhotons

)

Definition at line 85 of file mitkPAMonteCarloThreadHandler.cpp.

References m_WorkPackageSize.

Member Data Documentation

m_MutexRemainingPhotonsManipulation

std::mutex mitk::pa::MonteCarloThreadHandler::m_MutexRemainingPhotonsManipulation

protected

Definition at line 58 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage().

m_NumberPhotonsRemaining

long mitk::pa::MonteCarloThreadHandler::m_NumberPhotonsRemaining

protected

Definition at line 52 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_NumberPhotonsToSimulate

long mitk::pa::MonteCarloThreadHandler::m_NumberPhotonsToSimulate

protected

Definition at line 48 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_SimulateOnTimeBasis

bool mitk::pa::MonteCarloThreadHandler::m_SimulateOnTimeBasis

protected

Definition at line 56 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_SimulationTime

long mitk::pa::MonteCarloThreadHandler::m_SimulationTime

protected

Definition at line 54 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_Time

long mitk::pa::MonteCarloThreadHandler::m_Time

protected

Definition at line 55 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_Verbose

bool mitk::pa::MonteCarloThreadHandler::m_Verbose

protected

Definition at line 57 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), and MonteCarloThreadHandler().

m_WorkPackageSize

long mitk::pa::MonteCarloThreadHandler::m_WorkPackageSize

protected

Definition at line 53 of file mitkPAMonteCarloThreadHandler.h.

Referenced by GetNextWorkPackage(), MonteCarloThreadHandler(), and SetPackageSize().

---

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

• mitkPAMonteCarloThreadHandler.h
• mitkPAMonteCarloThreadHandler.cpp