CharmStrategy Class Reference
[Charm++ Communication Optimization Framework]

All Charm++ communication library strategies should inherit from CharmStrategy, rather than inheriting from class Strategy (or one of its subclasses). More...

#include <ComlibStrategy.h>

Inheritance diagram for CharmStrategy:

[legend]

Collaboration diagram for CharmStrategy:

[legend]

Public Member Functions
	CharmStrategy ()
	CharmStrategy (CkMigrateMessage *m)
void	setMulticast ()
CmiBool	getMulticast ()
void	setOnFinish (CkCallback of)
CkCallback	getOnFinish ()
ComlibLearner *	getLearner ()
void	setLearner (ComlibLearner *l)
virtual void	pup (PUP::er &p)
Data Fields
ComlibGroupInfo	ginfo
ComlibNodeGroupInfo	nginfo
ComlibArrayInfo	ainfo
	The communication library array listener watches and monitors the array elements belonging to ainfo.src_aid.
Protected Member Functions
int	deliverToIndices (void *msg, int numDestIdxs, const CkArrayIndex *indices)
	Deliver a message to a set of indices using the array manager.
void	deliverToIndices (void *msg, const CkVec< CkArrayIndex > &indices)
	Deliver a message to a set of indices using the array manager.
Protected Attributes
ComlibLearner *	learner
CmiBool	mflag
CkCallback	onFinish

---

Detailed Description

All Charm++ communication library strategies should inherit from CharmStrategy, rather than inheriting from class Strategy (or one of its subclasses).

They should specify their object domain by setting Strategy::type. They have three helpers predefined for them for node groups, groups and arrays.

Definition at line 357 of file ComlibStrategy.h.

---

Constructor & Destructor Documentation

CharmStrategy::CharmStrategy

(

)

[inline]

Definition at line 384 of file ComlibStrategy.h.

References CmiFalse, learner, and mflag.

CharmStrategy::CharmStrategy

(

CkMigrateMessage *

m

)

[inline]

Definition at line 392 of file ComlibStrategy.h.

References learner.

---

Member Function Documentation

void CharmStrategy::deliverToIndices	(	void *	msg,
		const CkVec< CkArrayIndex > &	indices
	)			[inline, protected]

Deliver a message to a set of indices using the array manager.

Indices can be local or remote.

Definition at line 370 of file ComlibStrategy.h.

References deliverToIndices(), CkVec< T >::getVec(), and CkVec< T >::size().

void CharmStrategy::setMulticast

(

)

[inline]

Definition at line 397 of file ComlibStrategy.h.

References CmiTrue, and mflag.

CmiBool CharmStrategy::getMulticast

(

)

[inline]

Definition at line 402 of file ComlibStrategy.h.

References mflag.

void CharmStrategy::setOnFinish

(

CkCallback

of

)

[inline]

Definition at line 406 of file ComlibStrategy.h.

References onFinish.

CkCallback CharmStrategy::getOnFinish

(

)

[inline]

Definition at line 410 of file ComlibStrategy.h.

References onFinish.

Referenced by EachToManyMulticastStrategy::notifyDone().

ComlibLearner* CharmStrategy::getLearner

(

)

[inline]

Definition at line 415 of file ComlibStrategy.h.

References learner.

Referenced by MulticastStrategy::~MulticastStrategy(), and RectMulticastStrategy::~RectMulticastStrategy().

void CharmStrategy::setLearner

(

ComlibLearner *

l

)

[inline]

Definition at line 416 of file ComlibStrategy.h.

References learner.

---

Field Documentation

ComlibLearner* CharmStrategy::learner [protected]

Definition at line 361 of file ComlibStrategy.h.

Referenced by RectMulticastStrategy::beginProcessing(), CharmStrategy(), getLearner(), and setLearner().

CmiBool CharmStrategy::mflag [protected]

Definition at line 362 of file ComlibStrategy.h.

Referenced by CharmStrategy(), getMulticast(), pup(), and setMulticast().

CkCallback CharmStrategy::onFinish [protected]

Definition at line 363 of file ComlibStrategy.h.

Referenced by getOnFinish(), pup(), and setOnFinish().

ComlibGroupInfo CharmStrategy::ginfo

Definition at line 377 of file ComlibStrategy.h.

Referenced by EachToManyMulticastStrategy::EachToManyMulticastStrategy(), and pup().

ComlibNodeGroupInfo CharmStrategy::nginfo

Definition at line 378 of file ComlibStrategy.h.

Referenced by pup().

ComlibArrayInfo CharmStrategy::ainfo

The communication library array listener watches and monitors the array elements belonging to ainfo.src_aid.

Definition at line 382 of file ComlibStrategy.h.

Referenced by RectMulticastStrategy::beginProcessing(), ComlibManager::bracketedReceiveCount(), BroadcastStrategy::BroadcastStrategy(), PipeBroadcastStrategy::deliver(), EachToManyMulticastStrategy::deliver(), EachToManyMulticastStrategy::EachToManyMulticastStrategy(), BroadcastStrategy::handleHypercube(), BroadcastStrategy::handleTree(), EachToManyMulticastStrategy::localMulticast(), PipeBroadcastStrategy::PipeBroadcastStrategy(), pup(), and RectMulticastStrategy::RectMulticastStrategy().

---

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

• ck-com/ComlibStrategy.h
• ck-com/ComlibStrategy.C