DestroyEvent< Dom > Class Template Reference

DestroyEvent: A class derived from ObserverEvent that stores information on how what elements to destroy in an engine. More...

#include <DynamicEvents.h>

Inheritance diagram for DestroyEvent< Dom >:

Inheritance graph
[legend]
Collaboration diagram for DestroyEvent< Dom >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef DynamicEvents::PatchID_t PatchID_t
typedef DynamicEvents::CreateSize_t CreateSize_t
typedef DynamicEventType< Dom >
::Domain_t 
Domain_t

Public Member Functions

template<class D >
 DestroyEvent (const D &d, PatchID_t p, int method)
virtual ~DestroyEvent ()
const Domain_tdomain () const
PatchID_t patch () const
int method () const


Detailed Description

template<class Dom>
class DestroyEvent< Dom >

DestroyEvent: A class derived from ObserverEvent that stores information on how what elements to destroy in an engine.

It stores info on the domain to destroy (domain()), the destroy method code (method()), and the patch to destroy in (patch()).

This is templated on the domain type, Dom.


Member Typedef Documentation

template<class Dom >
typedef DynamicEvents::PatchID_t DestroyEvent< Dom >::PatchID_t

template<class Dom >
typedef DynamicEvents::CreateSize_t DestroyEvent< Dom >::CreateSize_t

template<class Dom >
typedef DynamicEventType<Dom>::Domain_t DestroyEvent< Dom >::Domain_t


Constructor & Destructor Documentation

template<class Dom >
template<class D >
DestroyEvent< Dom >::DestroyEvent ( const D &  d,
PatchID_t  p,
int  method 
) [inline]

References CTAssert.

template<class Dom >
virtual DestroyEvent< Dom >::~DestroyEvent (  )  [inline, virtual]


Member Function Documentation

template<class Dom >
const Domain_t& DestroyEvent< Dom >::domain (  )  const [inline]

template<class Dom >
PatchID_t DestroyEvent< Dom >::patch (  )  const [inline]

template<class Dom >
int DestroyEvent< Dom >::method (  )  const [inline]


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

Generated on Wed Mar 16 06:19:48 2011 for FreePOOMA by  doxygen 1.5.9