smtk::task::Adaptor Class Reference

This object provides applications a way to configure a task using information adapted from its dependencies. More...

#include <Adaptor.h>

Inheritance diagram for smtk::task::Adaptor:

Collaboration diagram for smtk::task::Adaptor:

Public Types
using	Configuration = nlohmann::json
	Task adaptors are configured using JSON.

Public Member Functions
	smtkTypeMacroBase (smtk::task::Adaptor)
	Adaptor ()
	Construct an unconfigured adaptor.
	Adaptor (const Configuration &config)
	Adaptor (const Configuration &config, Task *from, Task *to)
virtual	~Adaptor ()=default
	Destructor must be virtual.
virtual bool	reconfigureTask ()=0
	Subclasses must implement this to reconfigure the "to()" task. More...
Task *	from () const
	The task this adaptor uses to fetch configuration parameters.
Task *	to () const
	The task to which this adaptor applies configuration parameters.

Protected Attributes
Task *	m_from
Task *	m_to
smtk::task::Task::Observers::Key	m_observer

Detailed Description

This object provides applications a way to configure a task using information adapted from its dependencies.

Member Function Documentation

reconfigureTask()

virtual bool smtk::task::Adaptor::reconfigureTask ( )

pure virtual

Subclasses must implement this to reconfigure the "to()" task.

This method is called when the "from()" task changes into a completable state.

Implemented in smtk::task::adaptor::ResourceAndRole.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/task/Adaptor.h
• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/task/Adaptor.cxx