SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
smtk::task::adaptor::ResourceAndRole Class Reference

Configure a task with a resource and role given a dependent producer. More...

#include <ResourceAndRole.h>

Inheritance diagram for smtk::task::adaptor::ResourceAndRole:
[legend]
Collaboration diagram for smtk::task::adaptor::ResourceAndRole:
[legend]

Public Member Functions

 smtkTypeMacro (smtk::task::adaptor::ResourceAndRole)
 
 smtkSuperclassMacro (smtk::task::Adaptor)
 
 smtkCreateMacro (smtk::task::Adaptor)
 
 ResourceAndRole ()
 Construct an unconfigured adaptor.
 
 ResourceAndRole (const Configuration &config)
 
 ResourceAndRole (const Configuration &config, Task *from, Task *to)
 
bool reconfigureTask () override
 Reconfigure the "to()" task. More...
 
- Public Member Functions inherited from smtk::task::Adaptor
 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.
 
Taskfrom () const
 The task this adaptor uses to fetch configuration parameters.
 
Taskto () const
 The task to which this adaptor applies configuration parameters.
 

Protected Member Functions

void configureSelf (const Configuration &config)
 

Protected Attributes

std::string m_fromTag
 
std::string m_toTag
 
- Protected Attributes inherited from smtk::task::Adaptor
Taskm_from
 
Taskm_to
 
smtk::task::Task::Observers::Key m_observer
 

Additional Inherited Members

- Public Types inherited from smtk::task::Adaptor
using Configuration = nlohmann::json
 Task adaptors are configured using JSON.
 

Detailed Description

Configure a task with a resource and role given a dependent producer.

Member Function Documentation

◆ reconfigureTask()

bool smtk::task::adaptor::ResourceAndRole::reconfigureTask ( )
overridevirtual

Reconfigure the "to()" task.

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

Implements smtk::task::Adaptor.


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