commore  1.0.6-SNAPSHOT
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
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 ActionGroup::abort ( Processor &  processor,
bool  wait = true 
)
void ActionGroup::add ( PAction  action)

Add an action to the set

Parameters
actionto add
Todo:
void add(const PAction& action);
void ActionGroup::clear ( )

Empty the action group

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

Action set accessor

void ActionGroup::reset ( )

Reset the to_stop status of all actions to false

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

Set action stop and abort

Parameters
processorwhere action is submitted
waituntil action stop running
Todo:
rename to set_to_stop and set_to_abort
int ActionGroup::wait ( Processor &  processor,
const int  timeout_ms = 0 
)

Wait until all actions are completed

Parameters
processor
timeout_mstimeout 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 files: