CkLocation Class Reference
[CkArrayImpl]

The "data" class passed to a CkLocIterator, which refers to a bound glob of array elements. More...

#include <cklocation.h>

Collaboration diagram for CkLocation:

[legend]

Public Member Functions
	CkLocation (CkLocMgr *mgr_, CkLocRec *rec_)
CkLocMgr *	getManager (void) const
	Find our location manager.
CkLocRec *	getLocalRecord (void) const
	Find the local record that refers to this element.
const CkArrayIndex &	getIndex (void) const
	Look up and return the array index of this location.
CmiUInt8	getID () const
void	destroyAll ()
void	pup (PUP::er &p)
	Pup all the array elements at this location.
Private Attributes
CkLocMgr *	mgr
CkLocRec *	rec

---

Detailed Description

The "data" class passed to a CkLocIterator, which refers to a bound glob of array elements.

This is a transient class-- do not attempt to store it or send it across processors.

Definition at line 225 of file cklocation.h.

---

Constructor & Destructor Documentation

CkLocation::CkLocation	(	CkLocMgr *	mgr_,
		CkLocRec *	rec_
	)

Definition at line 2852 of file cklocation.C.

---

Member Function Documentation

CkLocMgr* CkLocation::getManager

(

void

)

const [inline]

Find our location manager.

Definition at line 232 of file cklocation.h.

Referenced by CkElementInformHome::addLocation(), CkElementEvacuate::addLocation(), ElementDistributor::addLocation(), and sendBackImmigrantRecObjs().

Here is the caller graph for this function:

CkLocRec* CkLocation::getLocalRecord

(

void

)

const [inline]

Find the local record that refers to this element.

Definition at line 235 of file cklocation.h.

Referenced by MemElementPacker::addLocation(), CkElementEvacuate::addLocation(), ElementCaller::addLocation(), ElementDistributor::addLocation(), and sendBackImmigrantRecObjs().

Here is the caller graph for this function:

const CkArrayIndex & CkLocation::getIndex

(

void

)

const

Look up and return the array index of this location.

Definition at line 2855 of file cklocation.C.

References CkLocRec::getIndex(), and rec.

Referenced by CpdPythonArrayIterator::addLocation(), LocalBroadcaster< dtype, ClientType, EntryMethod >::addLocation(), CkCacheArrayCounter::addLocation(), CkArrayElementRangeIterator< T >::addLocation(), MemElementPacker::addLocation(), CkElementInformHome::addLocation(), CkElementEvacuate::addLocation(), ElementCheckpointer::addLocation(), ElementDistributor::addLocation(), ElementPacker::addLocation(), CkMemCheckPT::isMaster(), pupLocation(), ElementDistributor::pupLocation(), and sendBackImmigrantRecObjs().

Here is the call graph for this function:

Here is the caller graph for this function:

CmiUInt8 CkLocation::getID

(

)

const

Definition at line 2859 of file cklocation.C.

References CkLocRec::getID(), and rec.

Referenced by MemElementPacker::addLocation(), and ElementCheckpointer::addLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkLocation::destroyAll

(

)

Definition at line 2863 of file cklocation.C.

References CkLocMgr::callMethod(), CkMigratable::ckDestroy(), mgr, and rec.

Referenced by ElementDestroyer::addLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkLocation::pup

(

PUP::er &

p

)

Pup all the array elements at this location.

Definition at line 2867 of file cklocation.C.

References CkElementCreation_migrate, mgr, CkLocMgr::pupElementsFor(), and rec.

Here is the call graph for this function:

---

Field Documentation

CkLocMgr* CkLocation::mgr [private]

Definition at line 226 of file cklocation.h.

Referenced by destroyAll(), and pup().

CkLocRec* CkLocation::rec [private]

Definition at line 227 of file cklocation.h.

Referenced by destroyAll(), getID(), getIndex(), and pup().

---

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

• ck-core/cklocation.h
• ck-core/cklocation.C