Parallel::FMTPlanningTask Class Reference

Task to carry multiple parallel optimizations of different FMTModel using the doPlanning function. More...

#include <FMTPlanningTask.h>

Inheritance diagram for Parallel::FMTPlanningTask:

Collaboration diagram for Parallel::FMTPlanningTask:

Public Member Functions
	FMTPlanningTask ()=default
	Default constructor for FMTPlanningTask.
	FMTPlanningTask (const FMTPlanningTask &rhs)
	Default copy constructor for FMTPlanningTask.
FMTPlanningTask &	operator= (const FMTPlanningTask &rhs)
	Default copy assignment operator for FMTPlanningTask.
virtual	~FMTPlanningTask ()=default
	Destructor for FMTPlanningTask, taking care of writing the drift probabilities.
std::unique_ptr< FMTTask >	clone () const
	Clone function for FMTPlanningTask.
void	setKeepModels ()
	Force the task to keep the models, which may consume memory.
void	push_back (const Models::FMTModel &model, std::vector< Core::FMTSchedule >schedules=std::vector< Core::FMTSchedule >(), std::vector< Core::FMTOutput >louputs=std::vector< Core::FMTOutput >())
	Push a new FMTModel in the task queue with an optional schedule.
	FMTPlanningTask (const int &minoutputperiod, const int &maxoutputperiod, const std::string &outputlocation, std::string gdaldriver="CSV", std::vector< std::string >creationoptions=std::vector< std::string >(), Core::FMToutputlevel outputlevel=Core::FMToutputlevel::standard, std::string primaryfilelocation=std::string())
	Construct a FMTPlanningTask, mainly with the output parser parameters.
virtual std::vector< std::unique_ptr< FMTTask > >	split (const unsigned int &numberoftasks) const
	Split the main task into multiple planning tasks.
virtual std::unique_ptr< FMTTask >	spawn ()
	Spawn a minimal task from the master task.
virtual void	work ()
	Main function doing the planning task.
virtual void	finalize ()
	Do nothing at finalization.
void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger) override
	Pass in the logger.
template<class ptrtype >
const std::vector< const ptrtype * >	getModelsFromDynamicCast () const
	Return the models dynamically cast to the requested model type.
bool	SupportsMultiThreading () const override
	Check if the task support multithreading.
Public Member Functions inherited from Parallel::FMTTask
	FMTTask ()
	Default constructor for FMTTask.
virtual	~FMTTask ()=default
	Default virtual destructor for FMTTask.
	FMTTask (const FMTTask &rhs)
	Default copy constructor for FMTTask.
FMTTask &	operator= (const FMTTask &rhs)
	Default copy assignment operator for FMTTask.
virtual std::unique_ptr< FMTTask >	clone () const
	Clone function for FMTTask.
virtual std::vector< std::unique_ptr< FMTTask > >	split (const unsigned int &numberoftasks) const
	Split the actual task into multiple tasks.
virtual std::unique_ptr< FMTTask >	spawn ()
	Spawn a minimal task from the master task.
virtual void	work ()
	Main job executed by the thread.
virtual void	run ()
	Set up the crash handler and call work.
virtual void	finalize ()
	Called right after the last task is done, when overridden.
virtual bool	SupportsMultiThreading () const
	Check if the task support multithreading.
Public Member Functions inherited from Core::FMTObject
	FMTObject ()
	Default constructor for FMTObject.
virtual	~FMTObject ()
	Default virtual destructor for FMTObject.
	FMTObject (const std::unique_ptr< Exception::FMTExceptionHandler > exhandler)
	Construct a FMTObject passing in the exception handler of another FMTObject.
	FMTObject (const FMTObject &rhs)
	Copy constructor for FMTObject.
FMTObject &	operator= (const FMTObject &rhs)
	Copy assignment operator for FMTObject.
virtual void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger)
	Pass in the logger of another FMTObject.
void	passInExceptionHandler (const std::unique_ptr< Exception::FMTExceptionHandler > &exhandler)
	Pass in the exception handler of another FMTObject.
void	redirectLogToFile (const std::string &location)
	Redirect the log to a specific file, appending to it.
virtual void	setDefaultLogger ()
	Create and set a default logger to the FMTObject.
virtual void	setQuietLogger ()
	Create and set a quiet logger to the FMTObject.
virtual void	setTaskLogger ()
	Create and set a task logger to the FMTObject.
virtual void	setDebugLogger ()
	Create and set a debug logger to the FMTObject.
void	setDefaultExceptionHandler ()
	Create and set a default exception handler to the FMTObject.
void	setQuietExceptionHandler ()
	Create and set a quiet exception handler to the FMTObject.
void	setDebugExceptionHandler ()
	Create and set a debug exception handler to the FMTObject.
void	setFreeExceptionHandler ()
	Create and set a free exception handler to the FMTObject.
void	disableNestedExceptions ()
	Disable the nested exception throw of the exception handler.
void	enableNestedExceptions ()
	Enable the nested exception throw of the exception handler.
void	setErrorsToWarnings (const std::vector< Exception::FMTexc > &errors)
	Set a list of errors to be cast to warnings on the exception handler.
void	setMaxWarningsBeforeSilenced (const size_t &maxwarningcount)
	Set the number of warnings raised before being silenced.
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Additional Inherited Members
Static Public Member Functions inherited from Parallel::FMTTask
static std::string	getThreadId ()
	Return true if the job is all done.
static void	setTotalThreads (const size_t &p_threads)
	Set the total amount of threads.
Static Public Member Functions inherited from Core::FMTObject
static Logging::FMTLogger *	getLogger ()
	get a pointer to the actual logger.
static Exception::FMTExceptionHandler *	getExceptionHandler ()
	get a pointer to the actual exception handler.
static std::string	getRuntimeLocation ()
	Return the location of the FMT shared library.
static unsigned long long	getAvailableMemory ()
	Return the available memory in bytes.
static void	setTerminateStack ()
	will write the stack in the log when terminate called and raise a function failed.
static void	setAbortStack ()
	will write the stack in the log when abort called with SIGABRT and raise a function failed.
Public Attributes inherited from Parallel::FMTTask
bool	done
	If the task is done true else false.
Protected Member Functions inherited from Parallel::FMTTask
std::vector< size_t >	_splitWork (int numberoftasks, const int &totalworksize) const
	Change the status of the task.
void	_decrementWorkingThread ()
	Decrement the number of working threads.
void	_checkpoint ()
	Wait for the other threads to finish their jobs, then continue.
void	_setCrashHandlers ()
	Set the terminate and abort handlers before running the global function in the thread, and set the se_translator on Windows.
Protected Member Functions inherited from Core::FMTObject
template<class Archive >
void	forceSave (Archive &ar, const unsigned int version) const
	Force the serialization to save useful information, which the default FMTObject serialization does not.
template<class Archive >
void	forceLoad (Archive &ar, const unsigned int version)
	Force the serialization to load useful information, which the default FMTObject serialization does not.
void	checkSignals () const
	Check if the user has sent a ctrl-c signal using boost::python to FMT.
void	setCplHandler ()
	Pass the FMT exception handler to the GDAL exception handler (GDAL only).
Static Protected Member Functions inherited from Core::FMTObject
static std::chrono::time_point< std::chrono::high_resolution_clock >	getClock ()
	Return a clock of the current time.
template<class chrono >
static double	getDuration (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock as a double.
static std::string	getDurationInSeconds (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock in seconds as a string.
static void	_logStack ()
	Log the stack trace...
static void	_terminate ()
	Raise an error with the boost stacktrace.
static void	_abort (int p_signal)
	Raise an error with the boost stacktrace on abort.
Protected Attributes inherited from Parallel::FMTTask
std::unique_ptr< Logging::FMTLogger >	m_tasklogger
Static Protected Attributes inherited from Parallel::FMTTask
static boost::recursive_mutex	m_taskmutex
	Recursive mutex for the task.
Static Protected Attributes inherited from Core::FMTObject
static std::unique_ptr< Exception::FMTExceptionHandler >	_exhandler
	A shared pointer to the exception handler.
static std::unique_ptr< Logging::FMTLogger >	_logger
	A shared pointer to the logger.

Detailed Description

Task to carry multiple parallel optimizations of different FMTModel using the doPlanning function.

Constructor & Destructor Documentation

FMTPlanningTask() [1/3]

Parallel::FMTPlanningTask::FMTPlanningTask ( )

default

Default constructor for FMTPlanningTask.

FMTPlanningTask() [2/3]

Parallel::FMTPlanningTask::FMTPlanningTask

(

const FMTPlanningTask &

rhs

)

Default copy constructor for FMTPlanningTask.

Parameters

[in]

rhs

the FMTPlanningTask to copy.

~FMTPlanningTask()

virtual Parallel::FMTPlanningTask::~FMTPlanningTask ( )

virtualdefault

Destructor for FMTPlanningTask, taking care of writing the drift probabilities.

FMTPlanningTask() [3/3]

Parallel::FMTPlanningTask::FMTPlanningTask	(	const int &	minoutputperiod,
		const int &	maxoutputperiod,
		const std::string &	outputlocation,
		std::string	gdaldriver = "CSV",
		std::vector< std::string >	creationoptions = std::vector< std::string >(),
		Core::FMToutputlevel	outputlevel = Core::FMToutputlevel::standard,
		std::string	primaryfilelocation = std::string()
	)

Construct a FMTPlanningTask, mainly with the output parser parameters.

Parameters

[in]	minoutputperiod	the minimal output period.
[in]	maxoutputperiod	the maximal output period.
[in]	outputlocation	the output location.
[in]	gdaldriver	the GDAL driver.
[in]	creationoptions	the creation options.
[in]	outputlevel	the output level.
[in]	primaryfilelocation	the primary file location.

Member Function Documentation

clone()

std::unique_ptr< FMTTask > Parallel::FMTPlanningTask::clone ( ) const

virtual

Clone function for FMTPlanningTask.

Returns

a unique pointer to the cloned task.

Reimplemented from Parallel::FMTTask.

finalize()

virtual void Parallel::FMTPlanningTask::finalize ( )

virtual

Do nothing at finalization.

Reimplemented from Parallel::FMTTask.

getModelsFromDynamicCast()

template<class ptrtype >

const std::vector< const ptrtype * > Parallel::FMTPlanningTask::getModelsFromDynamicCast ( ) const

inline

Return the models dynamically cast to the requested model type.

Template Parameters

ptrtype

the model pointer type.

Returns

the casted models.

operator=()

FMTPlanningTask & Parallel::FMTPlanningTask::operator=

(

const FMTPlanningTask &

rhs

)

Default copy assignment operator for FMTPlanningTask.

Parameters

[in]

rhs

the FMTPlanningTask to copy.

Returns

a reference to this FMTPlanningTask.

passInLogger()

void Parallel::FMTPlanningTask::passInLogger ( const std::unique_ptr< Logging::FMTLogger > &  logger )

overridevirtual

Pass in the logger.

Parameters

[in]

logger

the logger.

Reimplemented from Core::FMTObject.

push_back()

void Parallel::FMTPlanningTask::push_back	(	const Models::FMTModel &	model,
		std::vector< Core::FMTSchedule >	schedules = std::vector< Core::FMTSchedule >(),
		std::vector< Core::FMTOutput >	louputs = std::vector< Core::FMTOutput >()
	)

Push a new FMTModel in the task queue with an optional schedule.

Keep only the outputs you want to get values from in the FMTModel.

Parameters

[in]	model	the model.
[in]	schedules	the schedules.
[in]	louputs	the outputs.

setKeepModels()

void Parallel::FMTPlanningTask::setKeepModels

(

)

Force the task to keep the models, which may consume memory.

spawn()

virtual std::unique_ptr< FMTTask > Parallel::FMTPlanningTask::spawn ( )

virtual

Spawn a minimal task from the master task.

Returns

a unique pointer to the spawned task.

Reimplemented from Parallel::FMTTask.

split()

virtual std::vector< std::unique_ptr< FMTTask > > Parallel::FMTPlanningTask::split ( const unsigned int &  numberoftasks ) const

virtual

Split the main task into multiple planning tasks.

Parameters

[in]

numberoftasks

the number of tasks.

Returns

the split tasks.

Reimplemented from Parallel::FMTTask.

SupportsMultiThreading()

bool Parallel::FMTPlanningTask::SupportsMultiThreading ( ) const

overridevirtual

Check if the task support multithreading.

Returns

true if it support

Reimplemented from Parallel::FMTTask.

work()

virtual void Parallel::FMTPlanningTask::work ( )

virtual

Main function doing the planning task.

Reimplemented from Parallel::FMTTask.

---

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

• D:/FMT/Include/FMTPlanningTask.h