A First-In-First-Out Thread Scheduler. More...

#include <ThreadScheduler.h>

Inheritance diagram for Mantid::Kernel::ThreadSchedulerFIFO:

Public Member Functions
void	clear () override
	Empty out the queue. More...

bool	empty () override

std::shared_ptr< Task >	pop (size_t threadnum) override
	Retrieves the next Task to execute. More...

void	push (std::shared_ptr< Task > newTask) override
	Add a Task to the queue. More...

size_t	size () override
	Returns the size of the queue. More...

	ThreadSchedulerFIFO ()

	~ThreadSchedulerFIFO () override
	Destructor. More...

Public Member Functions inherited from Mantid::Kernel::ThreadScheduler
virtual void	abort (std::runtime_error exception)
	Signal to the scheduler that a task is complete. More...

virtual void	clear ()=0
	Empty out the queue. More...

virtual bool	empty ()=0
	Returns true if the queue is empty. More...

virtual void	finished (Task *task, size_t threadnum)
	Signal to the scheduler that a task is complete. More...

bool	getAborted ()
	Returns true if the execution was aborted. More...

std::runtime_error	getAbortException ()
	Returns the exception that was caught, if any. More...

virtual std::shared_ptr< Task >	pop (size_t threadnum)=0
	Retrieves the next Task to execute. More...

virtual void	push (std::shared_ptr< Task > newTask)=0
	Add a Task to the queue. More...

virtual size_t	size ()=0
	Returns the size of the queue. More...

	ThreadScheduler ()
	Constructor. More...

double	totalCost ()
	Returns the total cost of all Task's in the queue. More...

double	totalCostExecuted ()
	Returns the total cost of all Task's in the queue. More...

virtual	~ThreadScheduler ()=default
	Destructor. More...

Protected Attributes
std::deque< std::shared_ptr< Task > >	m_queue
	Queue of tasks. More...

Protected Attributes inherited from Mantid::Kernel::ThreadScheduler
bool	m_aborted
	The run was aborted due to an exception. More...

std::runtime_error	m_abortException
	The exception that aborted the run. More...

double	m_cost
	Total cost of all tasks. More...

double	m_costExecuted
	Accumulated cost of tasks that have been executed (popped) More...

std::mutex	m_queueLock
	Mutex to prevent simultaneous access to the queue. More...

Detailed Description

A First-In-First-Out Thread Scheduler.

A queue of tasks is maintained and are run in the order they were submitted.

Definition at line 126 of file ThreadScheduler.h.

Constructor & Destructor Documentation

◆ ThreadSchedulerFIFO()

Mantid::Kernel::ThreadSchedulerFIFO::ThreadSchedulerFIFO ( )

inline

Definition at line 128 of file ThreadScheduler.h.

◆ ~ThreadSchedulerFIFO()

Mantid::Kernel::ThreadSchedulerFIFO::~ThreadSchedulerFIFO ( )

inlineoverride

Destructor.

Definition at line 131 of file ThreadScheduler.h.

Member Function Documentation

◆ clear()

void Mantid::Kernel::ThreadSchedulerFIFO::clear ( )

inlineoverridevirtual

Empty out the queue.

Implements Mantid::Kernel::ThreadScheduler.

Definition at line 174 of file ThreadScheduler.h.

◆ empty()

bool Mantid::Kernel::ThreadSchedulerFIFO::empty ( )

inlineoverridevirtual

Returns: true if the queue is empty

Implements Mantid::Kernel::ThreadScheduler.

Definition at line 135 of file ThreadScheduler.h.

◆ pop()

std::shared_ptr< Task > Mantid::Kernel::ThreadSchedulerFIFO::pop ( size_t threadnum )

inlineoverridevirtual

Retrieves the next Task to execute.

Parameters

threadnum :: ID of the calling thread.

Returns: a Task pointer to execute.

Implements Mantid::Kernel::ThreadScheduler.

Reimplemented in Mantid::Kernel::ThreadSchedulerLIFO.

Definition at line 150 of file ThreadScheduler.h.

References UNUSED_ARG.

◆ push()

void Mantid::Kernel::ThreadSchedulerFIFO::push ( std::shared_ptr< Task > newTask )

inlineoverridevirtual

Add a Task to the queue.

Parameters

newTask :: Task to add to queue

Implements Mantid::Kernel::ThreadScheduler.

Definition at line 141 of file ThreadScheduler.h.

◆ size()

size_t Mantid::Kernel::ThreadSchedulerFIFO::size ( )

inlineoverridevirtual

Returns the size of the queue.

Implements Mantid::Kernel::ThreadScheduler.

Definition at line 166 of file ThreadScheduler.h.

Referenced by Mantid::MDAlgorithms::ConvToMDEventsWS::appendEventsFromInputWS(), and Mantid::MDAlgorithms::ConvToMDHistoWS::runConversion().

Member Data Documentation

◆ m_queue

std::deque<std::shared_ptr<Task> > Mantid::Kernel::ThreadSchedulerFIFO::m_queue

protected

Queue of tasks.

Definition at line 185 of file ThreadScheduler.h.

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

Framework/Kernel/inc/MantidKernel/ThreadScheduler.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ThreadSchedulerFIFO()

◆ ~ThreadSchedulerFIFO()

Member Function Documentation

◆ clear()

◆ empty()

◆ pop()

◆ push()

◆ size()

Member Data Documentation

◆ m_queue