commore::ActionGroup Class Reference

#include <ActionGroup.h>

Public Member Functions
void	add (PAction action)
const commore::List< PAction > &	getActions () const
void	stop (Processor &processor, bool wait=true)
void	abort (Processor &processor, bool wait=true)
int	wait (Processor &processor, const int timeout_ms=0)
void	reset ()
void	clear ()

Detailed Description

Set of Action

Member Function Documentation

void commore::ActionGroup::add

(

PAction

action

)

Add an action to the set

Parameters

action

to add

Todo:

void add(const PAction& action);

void commore::ActionGroup::clear

(

)

Empty the action group

const commore::List<PAction>& commore::ActionGroup::getActions

(

)

const

Action set accessor

void commore::ActionGroup::reset

(

)

Reset the to_stop status of all actions to false

void commore::ActionGroup::stop	(	Processor &	processor,
		bool	wait = true
	)

Set action stop and abort

Parameters

processor	where action is submitted
wait	until action stop running

Todo:

rename to set_to_stop and set_to_abort

int commore::ActionGroup::wait	(	Processor &	processor,
		const int	timeout_ms = 0
	)

Wait until all actions are completed

Parameters

processor
timeout_ms	timeout in milliseconds

Returns

0 if a timeout occured != 0 if all the action are stopped

Todo:

change timeout type to TimePeriod

should return bool

---

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

• commore/ActionGroup.h