Task to find a suboptimal schedule for the operating areas of a FMTLpModel. More...

#include <FMTOpAreaSchedulerTask.h>

Inheritance diagram for Parallel::FMTOpAreaSchedulerTask:

Collaboration diagram for Parallel::FMTOpAreaSchedulerTask:

Public Member Functions
	FMTOpAreaSchedulerTask ()=default
	Default constructor for FMTOpAreaSchedulerTask.

	FMTOpAreaSchedulerTask (const FMTOpAreaSchedulerTask &rhs)
	Default copy constructor for FMTOpAreaSchedulerTask.

FMTOpAreaSchedulerTask &	operator= (const FMTOpAreaSchedulerTask &rhs)
	Default copy assignment operator for FMTOpAreaSchedulerTask.

virtual	~FMTOpAreaSchedulerTask ()=default
	Destructor for FMTOpAreaSchedulerTask, taking care of writing the solution.

std::unique_ptr< FMTTask >	clone () const
	Clone function for FMTOpAreaSchedulerTask.

	FMTOpAreaSchedulerTask (const Models::FMTLpModel &model, const std::vector< Heuristics::FMTOperatingAreaScheme > &opareas, const Core::FMTOutputNode &node, const std::string &outputlocation, const std::string &outputyieldname, const unsigned int &maxiterations, const int &maxtime, Core::FMTOutput returntime_output=Core::FMTOutput())
	Construct a FMTOpAreaSchedulerTask from a model, calling doPlanning on it and obtaining the operating area schemes from the FMTLpModel.

virtual std::vector< std::unique_ptr< FMTTask > >	split (const unsigned int &numberoftasks) const
	Split the main task into multiple operating area scheduler tasks.

virtual std::unique_ptr< FMTTask >	spawn ()
	Spawn a minimal task from the master task.

virtual void	work ()
	Main function doing the operating area scheduling task.

virtual void	finalize ()
	Write the solution at finalization.

void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger) override
	Pass in the logger.

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 find a suboptimal schedule for the operating areas of a FMTLpModel.

It keeps the best scheduler in memory and tries to modify its schedule to get a better objective value, generating time yields for the operating areas.

Constructor & Destructor Documentation

◆ FMTOpAreaSchedulerTask() [1/3]

Parallel::FMTOpAreaSchedulerTask::FMTOpAreaSchedulerTask ( )

default

Default constructor for FMTOpAreaSchedulerTask.

◆ FMTOpAreaSchedulerTask() [2/3]

Parallel::FMTOpAreaSchedulerTask::FMTOpAreaSchedulerTask ( const FMTOpAreaSchedulerTask & rhs )

Default copy constructor for FMTOpAreaSchedulerTask.

Parameters

[in] rhs the FMTOpAreaSchedulerTask to copy.

◆ ~FMTOpAreaSchedulerTask()

virtual Parallel::FMTOpAreaSchedulerTask::~FMTOpAreaSchedulerTask ( )

virtualdefault

Destructor for FMTOpAreaSchedulerTask, taking care of writing the solution.

◆ FMTOpAreaSchedulerTask() [3/3]

Parallel::FMTOpAreaSchedulerTask::FMTOpAreaSchedulerTask	(	const Models::FMTLpModel &	model,
		const std::vector< Heuristics::FMTOperatingAreaScheme > &	opareas,
		const Core::FMTOutputNode &	node,
		const std::string &	outputlocation,
		const std::string &	outputyieldname,
		const unsigned int &	maxiterations,
		const int &	maxtime,
		Core::FMTOutput	returntime_output = `Core::FMTOutput()`
	)

Construct a FMTOpAreaSchedulerTask from a model, calling doPlanning on it and obtaining the operating area schemes from the FMTLpModel.

The length and other parameters must be set before; if the return time output is non empty it is used to set the return time of each operating area scheme using the initial solution.

Parameters

[in]	model	the model.
[in]	opareas	the operating areas.
[in]	node	the output node.
[in]	outputlocation	the output location.
[in]	outputyieldname	the output yield name.
[in]	maxiterations	the maximum number of iterations.
[in]	maxtime	the maximum time.
[in]	returntime_output	the return time output.

Member Function Documentation

◆ clone()

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

virtual

Clone function for FMTOpAreaSchedulerTask.

Returns: a unique pointer to the cloned task.

Reimplemented from Parallel::FMTTask.

◆ finalize()

virtual void Parallel::FMTOpAreaSchedulerTask::finalize ( )

virtual

Write the solution at finalization.

Reimplemented from Parallel::FMTTask.

◆ operator=()

FMTOpAreaSchedulerTask & Parallel::FMTOpAreaSchedulerTask::operator= ( const FMTOpAreaSchedulerTask & rhs )

Default copy assignment operator for FMTOpAreaSchedulerTask.

Parameters

[in] rhs the FMTOpAreaSchedulerTask to copy.

Returns: a reference to this FMTOpAreaSchedulerTask.

◆ passInLogger()

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

overridevirtual

Pass in the logger.

Parameters

[in] logger the logger.

Reimplemented from Core::FMTObject.

◆ spawn()

virtual std::unique_ptr< FMTTask > Parallel::FMTOpAreaSchedulerTask::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::FMTOpAreaSchedulerTask::split ( const unsigned int & numberoftasks ) const

virtual

Split the main task into multiple operating area scheduler tasks.

Parameters

[in] numberoftasks the number of tasks.

Returns: the split tasks.

Reimplemented from Parallel::FMTTask.

◆ SupportsMultiThreading()

bool Parallel::FMTOpAreaSchedulerTask::SupportsMultiThreading ( ) const

overridevirtual

Check if the task support multithreading.

Returns: true if it support

Reimplemented from Parallel::FMTTask.

◆ work()

virtual void Parallel::FMTOpAreaSchedulerTask::work ( )

virtual

Main function doing the operating area scheduling task.

Reimplemented from Parallel::FMTTask.

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

D:/FMT/Include/FMTOpAreaSchedulerTask.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FMTOpAreaSchedulerTask() [1/3]

◆ FMTOpAreaSchedulerTask() [2/3]

◆ ~FMTOpAreaSchedulerTask()

◆ FMTOpAreaSchedulerTask() [3/3]

Member Function Documentation

◆ clone()

◆ finalize()

◆ operator=()

◆ passInLogger()

◆ spawn()

◆ split()

◆ SupportsMultiThreading()

◆ work()