X-Plane Remote Access Plugin and Client Library
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
xplra::MultiTaskRequest Class Reference

#include <MultiTaskRequest.h>

Inheritance diagram for xplra::MultiTaskRequest:
xplra::Request xplra::MultiTaskRequestTemplate< GetDataRefTask > xplra::MultiTaskRequestTemplate< SetDataRefTask > xplra::MultiTaskRequestTemplate< TaskClass > xplra::GetMultiDataRefRequest xplra::SetMultiDataRefRequest

Public Member Functions

virtual ~MultiTaskRequest ()
 
void addTask (Task *task)
 
size_t getNumTasks () const
 
TaskgetTask (size_t index) const
 
- Public Member Functions inherited from xplra::Request
 Request ()
 
virtual ~Request ()
 

Protected Member Functions

virtual void execute ()
 

Private Types

typedef std::vector< Task * > tasks_t
 

Private Attributes

tasks_t tasks
 

Detailed Description

A request containing several tasks which it performs one-by-one when executing the request. It owns the tasks, which get deleted when the request object is deleted.

Definition at line 54 of file MultiTaskRequest.h.

Member Typedef Documentation

◆ tasks_t

typedef std::vector<Task*> xplra::MultiTaskRequest::tasks_t
private

Type for the vector of the tasks.

Definition at line 60 of file MultiTaskRequest.h.

Constructor & Destructor Documentation

◆ ~MultiTaskRequest()

MultiTaskRequest::~MultiTaskRequest ( )
virtual

Destroy the request by deleting the tasks.

Definition at line 45 of file MultiTaskRequest.cc.

Member Function Documentation

◆ addTask()

void xplra::MultiTaskRequest::addTask ( Task task)
inline

Add a task to the request.

Definition at line 121 of file MultiTaskRequest.h.

◆ execute()

void MultiTaskRequest::execute ( )
protectedvirtual

Perform the tasks one-by-one.

Implements xplra::Request.

Definition at line 54 of file MultiTaskRequest.cc.

◆ getNumTasks()

size_t xplra::MultiTaskRequest::getNumTasks ( ) const
inline

Get the number of tasks.

Definition at line 128 of file MultiTaskRequest.h.

◆ getTask()

Task * xplra::MultiTaskRequest::getTask ( size_t  index) const
inline

Get the task at the given index.

Definition at line 135 of file MultiTaskRequest.h.

Member Data Documentation

◆ tasks

tasks_t xplra::MultiTaskRequest::tasks
private

The tasks.

Definition at line 65 of file MultiTaskRequest.h.


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