SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
smtk::task::Manager Class Reference

A task manager is responsible for creating new tasks. More...

#include <Manager.h>

Inheritance diagram for smtk::task::Manager:
[legend]
Collaboration diagram for smtk::task::Manager:
[legend]

Public Types

using TaskInstances = smtk::task::Instances
 Managed instances of Task objects (and a registry of Task classes).
 
using AdaptorInstances = smtk::task::adaptor::Instances
 Managed instances of Adaptor objects (and a registry of Adaptor classes).
 

Public Member Functions

 smtkTypeMacroBase (smtk::task::Manager)
 
 smtkCreateMacro (smtk::task::Manager)
 
 Manager (smtk::resource::Resource *parent)
 
 Manager (const Manager &)=delete
 
void operator= (const Manager &)=delete
 
TaskInstancestaskInstances ()
 Return the set of managed task instances. More...
 
const TaskInstancestaskInstances () const
 
Activeactive ()
 Return a tracker for the active task.
 
const Activeactive () const
 
AdaptorInstancesadaptorInstances ()
 Return the set of managed adaptor instances. More...
 
const AdaptorInstancesadaptorInstances () const
 
smtk::common::Managers::Ptr managers () const
 Return the managers instance that contains this manager, if it exists.
 
void setManagers (const smtk::common::Managers::Ptr &managers)
 
nlohmann::json getStyle (const smtk::string::Token &styleClass) const
 Given a style key, return a style config.
 
nlohmann::json getStyles () const
 
void setStyles (const nlohmann::json &styles)
 
smtk::resource::Resourceresource () const
 If this manager is owned by a resource (typically a project), return it.
 
Gallerygallery ()
 Return a gallery of Task Worklets.
 
const Gallerygallery () const
 
TaskManagerTaskObserverstaskObservers ()
 Return the set of observers of task events (so you can insert/remove an observer).
 
TaskManagerAdaptorObserversadaptorObservers ()
 Return the set of observers of adaptor events (so you can insert/remove an observer).
 
TaskManagerWorkflowObserversworkflowObservers ()
 Return the set of observers of workflow events (so you can insert/remove an observer).
 

Static Public Member Functions

static constexpr smtk::operation::Observers::Priority operationObserverPriority ()
 Use an elevated priority for the task-manager's observation of operations. More...
 

Detailed Description

A task manager is responsible for creating new tasks.

Eventually, the task manager will also hold an inventory of created tasks and be a clearinghouse for task state transitions.

Member Function Documentation

◆ adaptorInstances()

AdaptorInstances& smtk::task::Manager::adaptorInstances ( )
inline

Return the set of managed adaptor instances.

This class also acts as a registrar for Adaptor subclasses.

◆ operationObserverPriority()

static constexpr smtk::operation::Observers::Priority smtk::task::Manager::operationObserverPriority ( )
inlinestaticconstexpr

Use an elevated priority for the task-manager's observation of operations.

This is done so that task-related events are emitted before other ordinary-priority operation observations (especially hint-processing).

◆ taskInstances()

TaskInstances& smtk::task::Manager::taskInstances ( )
inline

Return the set of managed task instances.

This class also acts as a registrar for Task subclasses.


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