CopyPatchEvent Class Reference

CopyPatchEvent: A class derived from ObserverEvent that stores information on what elements to copy in an engine. More...

#include <DynamicEvents.h>

Inheritance diagram for CopyPatchEvent:

Inheritance graph
[legend]
Collaboration diagram for CopyPatchEvent:

Collaboration graph
[legend]

List of all members.

Public Types

typedef DynamicEvents::PatchID_t PatchID_t
typedef DynamicEvents::CreateSize_t CreateSize_t
typedef IndirectionList
< IndirectionList< int > > 
Domain_t
typedef IndirectionList< int > IDList_t

Public Member Functions

 CopyPatchEvent (const Domain_t &domlists, const IDList_t &fromlist, PatchID_t top, bool create)
virtual ~CopyPatchEvent ()
const Domain_tdomainLists () const
const IDList_tfromPatch () const
PatchID_t toPatch () const
bool create () const


Detailed Description

CopyPatchEvent: A class derived from ObserverEvent that stores information on what elements to copy in an engine.

This is a special form of copy that uses a lists of IndirectionLists, one for each of a set of patches, and copies elements from the specified patches (also given in an IndirectionList) into a requested destination patch. This is also special in that it can be used in a way that will not require a "create", in case the user did this themselves earlier. This is not templated since it expects to work with int IndirectionLists's.

The copy information is provided as an IndirectionList<IndirectionList<int>> object, with one element per patch to copy from. A second IndirectionList<int> is required, of the same length as the first list, with patch ID's for the patches to copy from. The actual element indices should be "relative" indices, and contained only within the relevent source patch.


Member Typedef Documentation


Constructor & Destructor Documentation

CopyPatchEvent::CopyPatchEvent ( const Domain_t domlists,
const IDList_t fromlist,
PatchID_t  top,
bool  create 
) [inline]

virtual CopyPatchEvent::~CopyPatchEvent (  )  [inline, virtual]


Member Function Documentation

const Domain_t& CopyPatchEvent::domainLists (  )  const [inline]

const IDList_t& CopyPatchEvent::fromPatch (  )  const [inline]

PatchID_t CopyPatchEvent::toPatch (  )  const [inline]

bool CopyPatchEvent::create (  )  const [inline]


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

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