NDEVR
API Documentation
DesignTaskManager

Manages all active and inactive tasks for a DesignObjectLookup. More...

Collaboration diagram for DesignTaskManager:
[legend]

Public Member Functions

virtual void addTask (const DesignTask &task)
 Adds a new task to the manager.
virtual bool canExitApplication () const
 Checks whether the application is allowed to exit based on active tasks.
virtual bool canImportFile () const
 Checks whether importing a file is allowed based on active tasks.
virtual bool canOpenProject () const
 Checks whether opening a project is allowed based on active tasks.
virtual void removeTask (const UUID &id)
 Removes a task from the manager by its UUID.
DesignTask task (const UUID &id) const
 Retrieves a copy of a task by its UUID.
virtual void updateTask (const DesignTask &task)
 Updates an existing task in the manager, replacing it by its UUID.

Public Attributes

Dictionary< UUID, DesignTaskm_tasks
 Thread-safe dictionary of all managed tasks, keyed by UUID.

Detailed Description

Manages all active and inactive tasks for a DesignObjectLookup.


Definition at line 28 of file DesignTask.h.

Member Function Documentation

◆ addTask()

virtual void DesignTaskManager::addTask ( const DesignTask & task)
inlinevirtual

Adds a new task to the manager.

Parameters
[in]taskThe task to add.

Definition at line 69 of file DesignTask.h.

References m_tasks, and task().

◆ canExitApplication()

virtual bool DesignTaskManager::canExitApplication ( ) const
inlinevirtual

Checks whether the application is allowed to exit based on active tasks.

Returns
True if no active task prevents application close, false otherwise.

Definition at line 33 of file DesignTask.h.

References m_tasks.

◆ canImportFile()

virtual bool DesignTaskManager::canImportFile ( ) const
inlinevirtual

Checks whether importing a file is allowed based on active tasks.

Returns
True if no active task prevents file import, false otherwise.

Definition at line 57 of file DesignTask.h.

References m_tasks.

◆ canOpenProject()

virtual bool DesignTaskManager::canOpenProject ( ) const
inlinevirtual

Checks whether opening a project is allowed based on active tasks.

Returns
True if no active task prevents opening a project, false otherwise.

Definition at line 45 of file DesignTask.h.

References m_tasks.

◆ removeTask()

virtual void DesignTaskManager::removeTask ( const UUID & id)
inlinevirtual

Removes a task from the manager by its UUID.

Parameters
[in]idThe UUID of the task to remove.

Definition at line 83 of file DesignTask.h.

References m_tasks.

◆ task()

DesignTask DesignTaskManager::task ( const UUID & id) const
inline

Retrieves a copy of a task by its UUID.

Parameters
[in]idThe UUID of the task to retrieve.
Returns
A copy of the DesignTask with the given id.

Definition at line 91 of file DesignTask.h.

References m_tasks.

Referenced by addTask(), and updateTask().

◆ updateTask()

virtual void DesignTaskManager::updateTask ( const DesignTask & task)
inlinevirtual

Updates an existing task in the manager, replacing it by its UUID.

Parameters
[in]taskThe task with updated values.

Definition at line 76 of file DesignTask.h.

References m_tasks, and task().


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