Public Types | Public Member Functions | Private Attributes

LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE > Class Template Reference

A Handler is similar to an Action in the sense it will act upon commands invoked by the user. More...

#include <handler.h>

Inherited by LibGeoDecomp::RemoteSteererHelpers::GetHandler< CELL_TYPE, MEMBER_TYPE >.

Collaboration diagram for LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
APITraits::SelectTopology
< CELL_TYPE >::Value 
Topology
typedef GridBase< CELL_TYPE,
Topology::DIM
GridType

Public Member Functions

 Handler (const std::string &myKey)
virtual ~Handler ()
virtual bool operator() (const StringVec &parameters, Pipe &pipe, GridType *grid, const Region< Topology::DIM > &validRegion, unsigned step)=0
 Hanlde command specified by parameters; returns true if command was processed, false if command should be requeued.
virtual std::string key ()

Private Attributes

std::string myKey

Detailed Description

template<typename CELL_TYPE>
class LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >

A Handler is similar to an Action in the sense it will act upon commands invoked by the user.

Unlike Actions, a Handler has direct access to the grid, but will be triggered by the RemoteSteerer, not via the CommandServer.


Member Typedef Documentation

template<typename CELL_TYPE >
typedef GridBase<CELL_TYPE, Topology::DIM> LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::GridType
template<typename CELL_TYPE >
typedef APITraits::SelectTopology<CELL_TYPE>::Value LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::Topology

Constructor & Destructor Documentation

template<typename CELL_TYPE >
LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::Handler ( const std::string &  myKey  )  [inline, explicit]
template<typename CELL_TYPE >
virtual LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::~Handler (  )  [inline, virtual]

Member Function Documentation

template<typename CELL_TYPE >
virtual std::string LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::key (  )  [inline, virtual]
template<typename CELL_TYPE >
virtual bool LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::operator() ( const StringVec parameters,
Pipe pipe,
GridType grid,
const Region< Topology::DIM > &  validRegion,
unsigned  step 
) [pure virtual]

Hanlde command specified by parameters; returns true if command was processed, false if command should be requeued.

This is useful if for instance not all relevant cells were available in validRegion.


Member Data Documentation

template<typename CELL_TYPE >
std::string LibGeoDecomp::RemoteSteererHelpers::Handler< CELL_TYPE >::myKey [private]

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