PEARL
Parallel Event Access and Replay Library
List of all members
pearl::CompoundTask Class Reference

Maintains a set of tasks and executes them in sequence. More...

#include <pearl/CompoundTask.h>

Inheritance diagram for pearl::CompoundTask:
pearl::Task

Public Member Functions

Constructors & destructor
 CompoundTask ()
 
virtual ~CompoundTask ()
 
Executing the subtasks
virtual bool execute ()
 
Task handling
void add_task (Task *task)
 
uint32_t num_steps () const
 
uint32_t current_step () const
 
- Public Member Functions inherited from pearl::Task
CompoundTaskget_parent () const
 
virtual ~Task ()
 

Protected Member Functions

Execution control
virtual bool prepare ()
 
virtual bool finish ()
 
- Protected Member Functions inherited from pearl::Task
 Task ()
 

Detailed Description

A CompoundTask maintains a list of subtasks and executes them in the order they were added. Subtasks can be added with CompoundTask::add_task().

CompoundTask takes ownership of the task objects associated with it and will automatically free them on destruction.

Constructor & Destructor Documentation

◆ CompoundTask()

pearl::CompoundTask::CompoundTask ( )

◆ ~CompoundTask()

virtual pearl::CompoundTask::~CompoundTask ( )
virtual

Member Function Documentation

◆ add_task()

void pearl::CompoundTask::add_task ( Task task)

◆ current_step()

uint32_t pearl::CompoundTask::current_step ( ) const

◆ execute()

virtual bool pearl::CompoundTask::execute ( )
virtual

Implements pearl::Task.

◆ finish()

virtual bool pearl::CompoundTask::finish ( )
protectedvirtual

◆ num_steps()

uint32_t pearl::CompoundTask::num_steps ( ) const

◆ prepare()

virtual bool pearl::CompoundTask::prepare ( )
protectedvirtual

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

Scalasca    Copyright © 1998–2019 Forschungszentrum Jülich GmbH, Jülich Supercomputing Centre
Copyright © 2009–2015 German Research School for Simulation Sciences GmbH, Laboratory for Parallel Programming