PPL Logo

PUP::er Class Reference

#include <pup.h>

Inheritance diagram for PUP::er:

Inheritance graph
[legend]
Collaboration diagram for PUP::er:

Collaboration graph
[legend]

Public Member Functions

virtual ~er ()
bool isSizing (void) const
bool isPacking (void) const
bool isUnpacking (void) const
const char * typeString () const
unsigned int getStateFlags (void) const
void becomeDeleting (void)
bool isDeleting (void) const
void becomeUserlevel (void)
bool isUserlevel (void) const
void becomeRestarting (void)
bool isRestarting (void) const
bool hasComments (void) const
void operator() (signed char &v)
void operator() (char &v)
void operator() (short &v)
void operator() (int &v)
void operator() (long &v)
void operator() (unsigned char &v)
void operator() (unsigned short &v)
void operator() (unsigned int &v)
void operator() (unsigned long &v)
void operator() (float &v)
void operator() (double &v)
void operator() (long double &v)
void operator() (bool &v)
void operator() (CMK_PUP_LONG_LONG &v)
void operator() (unsigned CMK_PUP_LONG_LONG &v)
void operator() (CmiInt16 &v)
void operator() (CmiUInt16 &v)
void operator() (void *&v, void *sig)
void operator() (signed char *a, size_t nItems)
void operator() (char *a, size_t nItems)
void operator() (short *a, size_t nItems)
void operator() (int *a, size_t nItems)
void operator() (long *a, size_t nItems)
void operator() (unsigned char *a, size_t nItems)
void operator() (unsigned short *a, size_t nItems)
void operator() (unsigned int *a, size_t nItems)
void operator() (unsigned long *a, size_t nItems)
void operator() (float *a, size_t nItems)
void operator() (double *a, size_t nItems)
void operator() (long double *a, size_t nItems)
void operator() (bool *a, size_t nItems)
void operator() (CMK_PUP_LONG_LONG *a, size_t nItems)
void operator() (unsigned CMK_PUP_LONG_LONG *a, size_t nItems)
void operator() (CmiInt16 *a, size_t nItems)
void operator() (CmiUInt16 *a, size_t nItems)
void operator() (void **a, size_t nItems, void *pointerSignature)
void operator() (able **a)
void operator() (able &a)
virtual void comment (const char *message)
 A descriptive (but entirely optional) human-readable comment field.
virtual void synchronize (unsigned int sync)
 A 32-bit "synchronization marker" (not human readable).
void syncComment (unsigned int sync, const char *message=0)
 Insert a synchronization marker and comment into the stream.
virtual void bytes (void *p, size_t n, size_t itemSize, dataType t)=0
virtual void object (able **a)
virtual size_t size (void) const
virtual void impl_startSeek (seekBlock &s)
 PUP::er seek implementation routines.
virtual size_t impl_tell (seekBlock &s)
virtual void impl_seek (seekBlock &s, size_t off)
virtual void impl_endSeek (seekBlock &s)
virtual void pupCmiAllocBuf (void **msg)
virtual void pupCmiAllocBuf (void **msg, size_t size)

Protected Types

enum  { IS_USERLEVEL = 0x0004, IS_DELETING = 0x0008, IS_COMMENTS = 0x0010, IS_RESTARTING = 0x0020 }
 These state bits describe various user-settable properties. More...
enum  { IS_SIZING = 0x0100, IS_PACKING = 0x0200, IS_UNPACKING = 0x0400, TYPE_MASK = 0xFF00 }
 These state bits describe the PUP::er's direction. More...

Protected Member Functions

 er (unsigned int inType)

Protected Attributes

unsigned int PUP_er_state

Private Member Functions

 er (const er &p)

Detailed Description

Definition at line 168 of file pup.h.


Member Enumeration Documentation

anonymous enum [protected]

These state bits describe various user-settable properties.

Enumerator:
IS_USERLEVEL 
IS_DELETING 
IS_COMMENTS 
IS_RESTARTING 

Definition at line 173 of file pup.h.

anonymous enum [protected]

These state bits describe the PUP::er's direction.

Enumerator:
IS_SIZING 
IS_PACKING 
IS_UNPACKING 
TYPE_MASK 

Definition at line 179 of file pup.h.


Constructor & Destructor Documentation

PUP::er::er ( const er p  )  [private]

PUP::er::er ( unsigned int  inType  )  [inline, explicit, protected]

Definition at line 186 of file pup.h.

PUP::er::~er (  )  [virtual]

Definition at line 56 of file pup_util.C.


Member Function Documentation

bool PUP::er::isSizing ( void   )  const [inline]

Definition at line 191 of file pup.h.

References IS_SIZING, and PUP_er_state.

Referenced by TCharm::pup(), Boomarray< T >::pup(), ArmciStridedMsg::pup(), ArmciMsg::pup(), ChareMlogData::pup(), ArrayElemExt::pup(), and typeString().

Here is the caller graph for this function:

bool PUP::er::isPacking ( void   )  const [inline]

bool PUP::er::isUnpacking ( void   )  const [inline]

Definition at line 193 of file pup.h.

References IS_UNPACKING, and PUP_er_state.

Referenced by ReadOnlyExt::_roPup(), CkPupArrayElementsData(), CkPupChareData(), CkPupMainChareData(), CkPupMessage(), CkPupPerPlaceData(), CkPupROData(), eventQueue::CommitEvents(), CtgPup(), CkMemCheckPT::isMaster(), object(), PUP::operator|(), RandomSequence< T >::pup(), PUP::pup(), CkSequence< T >::pup(), CkPagedVector< T >::pup(), CkPupAllocatePtr< T >::pup(), CkPupAlwaysAllocatePtr< T >::pup(), CkQ< OBJ >::pup(), CkHashtableT< intdual, int >::pup(), CkBitVector::pup(), TCharm::UserData::pup(), TCharm::pup(), SRtable::pup(), SRentry::pup(), sim::pup(), GVT::pup(), PVT::pup(), Event::pup(), EqHeap::pup(), HeapNode::pup(), CancelList::pup(), NetFEM_update::pup(), NetFEM_elems::pup(), NetFEM_doubleField::pup(), GroupChunkMeshStreamer< dtype, ClientType, RouterType, EntryMethod >::pup(), ChunkOutOfOrderBuffer::pup(), ChunkReceiveBuffer::pup(), ArrayMeshStreamer< dtype, itype, ClientType, RouterType, EntryMethod >::pup(), GroupMeshStreamer< dtype, ClientType, RouterType, EntryMethod >::pup(), MeshStreamer< dtype >::pup(), MSA_PageArray< ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE >::pup(), MSA_PageT< ENTRY, MERGER, ENTRIES_PER_PAGE >::pup(), MSA::MSA3D< ENTRY, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE >::pup(), MSA::MSA1D< ElemList< T >, DefaultListEntry< ElemList< T >, true >, MSA_DEFAULT_ENTRIES_PER_PAGE >::pup(), MSA::MSAHandle< MSA::MSA1D< ElemList, DefaultListEntry< ElemList, true >, MSA_DEFAULT_ENTRIES_PER_PAGE > >::pup(), block::pup(), MBlockChunk::pup(), IDXL_Chunk::pup(), LineFFTinfo::pup(), NormalFFTinfo::pup(), ghostdata::pup(), MeshElem::pup(), NodeElem::pup(), ElemList< T >::pup(), FEM_Entity_Types< FEM_Elem >::pup(), FEM_Entity::pup(), FEM_Attribute::pup(), FEM_Comm_Holder::pup(), FEM_ElemAdj_Layer::pup(), FEM_Ghost_Layer::pup(), FuncCkLoop::pup(), CkCacheManager< CkCacheKey >::pup(), Boomarray< T >::pup(), ArmciStridedMsg::pup(), ArmciMsg::pup(), Cell3D::pup(), Cell1D::pup(), Cell2D::pup(), Cell::pup(), NeighborMsg::pup(), CtgGlobalStruct::pup(), LogEntry::pup(), NullLB::pup(), CkMarshalledNLBStatsMessage::pup(), NLBStatsMsg::pup(), MetaBalancer::pup(), _LDCommDesc::pup(), LBDatabase::pup(), CkMarshalledCLBStatsMessage::pup(), CLBStatsMsg::pup(), CentralLB::pup(), BaseLB::ProcStats::pup(), BaseLB::LDStats::pup(), BaseLB::pup(), redistributor2D::pup(), SDAG::Buffer::pup(), SDAG::MsgClosure::pup(), SDAG::TransportableBigSimLog::pup(), envelope::pup(), CkNodeReductionMgr::pup(), CkReduction::tupleElement::pup(), CkReductionMgr::pup(), RSSN::pup(), CkMemCheckPT::pup(), CkLocMgr::pup(), CkMigratable::pup(), PropMap::pup(), DefaultArrayMap::pup(), SNToTicket::pup(), ChareMlogData::pup(), RestoredLocalMap::pup(), MlogEntry::pup(), ArrayElemExt::pup(), CkArrayBroadcaster::pup(), CkArrayReducer::pup(), CkArray::pup(), ArrayElement::pup(), VidBlock::pup(), CProxy::pup(), Chare::pup(), CkMsgQ< CkReductionMsg >::pup(), PUP::PUP_stl_container_items(), PUP::PUP_stl_forward_list(), PUP::PUP_stl_map(), CkMemCheckPT::pupAllElements(), pupArrayElementsSkip(), CkCompactVec< T >::pupbase(), CkVec< CkZeroPtr< T, PUP_PTR > >::pupbase(), CkLocMgr::pupElementsFor(), PUPmarshall(), CkPagedVector< T >::pupPage(), FEM_Attribute::pupSingle(), TCharm::pupThread(), PUP::seekBlock::seek(), and typeString().

const char * PUP::er::typeString (  )  const

Definition at line 64 of file pup_util.C.

References isPacking(), isSizing(), and isUnpacking().

Referenced by CkPupArrayElementsData(), CkPupMainChareData(), and CkPupPerPlaceData().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int PUP::er::getStateFlags ( void   )  const [inline]

Definition at line 195 of file pup.h.

References PUP_er_state.

void PUP::er::becomeDeleting ( void   )  [inline]

Definition at line 198 of file pup.h.

References IS_DELETING, and PUP_er_state.

Referenced by CkLocMgr::emigrate().

Here is the caller graph for this function:

bool PUP::er::isDeleting ( void   )  const [inline]

Definition at line 199 of file pup.h.

References IS_DELETING, and PUP_er_state.

Referenced by ArmciStridedMsg::pup(), ArmciMsg::pup(), pupFEM_Chunk(), and pupIDXL_Chunk().

Here is the caller graph for this function:

void PUP::er::becomeUserlevel ( void   )  [inline]

Definition at line 202 of file pup.h.

References IS_USERLEVEL, and PUP_er_state.

bool PUP::er::isUserlevel ( void   )  const [inline]

Definition at line 203 of file pup.h.

References IS_USERLEVEL, and PUP_er_state.

void PUP::er::becomeRestarting ( void   )  [inline]

Definition at line 206 of file pup.h.

References IS_RESTARTING, and PUP_er_state.

bool PUP::er::isRestarting ( void   )  const [inline]

Definition at line 207 of file pup.h.

References IS_RESTARTING, and PUP_er_state.

bool PUP::er::hasComments ( void   )  const [inline]

Definition at line 209 of file pup.h.

References IS_COMMENTS, and PUP_er_state.

Referenced by syncComment().

Here is the caller graph for this function:

void PUP::er::operator() ( signed char &  v  )  [inline]

Definition at line 212 of file pup.h.

void PUP::er::operator() ( char &  v  )  [inline]

Definition at line 214 of file pup.h.

void PUP::er::operator() ( short &  v  )  [inline]

Definition at line 216 of file pup.h.

void PUP::er::operator() ( int v  )  [inline]

Definition at line 217 of file pup.h.

void PUP::er::operator() ( long &  v  )  [inline]

Definition at line 218 of file pup.h.

void PUP::er::operator() ( unsigned char &  v  )  [inline]

Definition at line 219 of file pup.h.

void PUP::er::operator() ( unsigned short &  v  )  [inline]

Definition at line 220 of file pup.h.

void PUP::er::operator() ( unsigned int v  )  [inline]

Definition at line 221 of file pup.h.

void PUP::er::operator() ( unsigned long &  v  )  [inline]

Definition at line 222 of file pup.h.

void PUP::er::operator() ( float v  )  [inline]

Definition at line 223 of file pup.h.

void PUP::er::operator() ( double &  v  )  [inline]

Definition at line 224 of file pup.h.

void PUP::er::operator() ( long double &  v  )  [inline]

Definition at line 226 of file pup.h.

void PUP::er::operator() ( bool v  )  [inline]

Definition at line 228 of file pup.h.

void PUP::er::operator() ( CMK_PUP_LONG_LONG &  v  )  [inline]

Definition at line 230 of file pup.h.

void PUP::er::operator() ( unsigned CMK_PUP_LONG_LONG &  v  )  [inline]

Definition at line 231 of file pup.h.

void PUP::er::operator() ( CmiInt16 v  )  [inline]

Definition at line 234 of file pup.h.

void PUP::er::operator() ( CmiUInt16 v  )  [inline]

Definition at line 235 of file pup.h.

void PUP::er::operator() ( void *&  v,
void *  sig 
) [inline]

Definition at line 237 of file pup.h.

void PUP::er::operator() ( signed char *  a,
size_t  nItems 
) [inline]

Definition at line 241 of file pup.h.

References bytes(), and PUP::Tchar.

Here is the call graph for this function:

void PUP::er::operator() ( char *  a,
size_t  nItems 
) [inline]

Definition at line 244 of file pup.h.

References bytes(), and PUP::Tchar.

Here is the call graph for this function:

void PUP::er::operator() ( short *  a,
size_t  nItems 
) [inline]

Definition at line 247 of file pup.h.

References bytes(), and PUP::Tshort.

Here is the call graph for this function:

void PUP::er::operator() ( int a,
size_t  nItems 
) [inline]

Definition at line 249 of file pup.h.

References bytes(), and PUP::Tint.

Here is the call graph for this function:

void PUP::er::operator() ( long *  a,
size_t  nItems 
) [inline]

Definition at line 251 of file pup.h.

References bytes(), and PUP::Tlong.

Here is the call graph for this function:

void PUP::er::operator() ( unsigned char *  a,
size_t  nItems 
) [inline]

Definition at line 255 of file pup.h.

References bytes(), and PUP::Tuchar.

Here is the call graph for this function:

void PUP::er::operator() ( unsigned short *  a,
size_t  nItems 
) [inline]

Definition at line 257 of file pup.h.

References bytes(), and PUP::Tushort.

Here is the call graph for this function:

void PUP::er::operator() ( unsigned int a,
size_t  nItems 
) [inline]

Definition at line 259 of file pup.h.

References bytes(), and PUP::Tuint.

Here is the call graph for this function:

void PUP::er::operator() ( unsigned long *  a,
size_t  nItems 
) [inline]

Definition at line 261 of file pup.h.

References bytes(), and PUP::Tulong.

Here is the call graph for this function:

void PUP::er::operator() ( float a,
size_t  nItems 
) [inline]

Definition at line 265 of file pup.h.

References bytes(), and PUP::Tfloat.

Here is the call graph for this function:

void PUP::er::operator() ( double *  a,
size_t  nItems 
) [inline]

Definition at line 267 of file pup.h.

References bytes(), and PUP::Tdouble.

Here is the call graph for this function:

void PUP::er::operator() ( long double *  a,
size_t  nItems 
) [inline]

Definition at line 271 of file pup.h.

References bytes(), and PUP::Tlongdouble.

Here is the call graph for this function:

void PUP::er::operator() ( bool a,
size_t  nItems 
) [inline]

Definition at line 276 of file pup.h.

References bytes(), and PUP::Tbool.

Here is the call graph for this function:

void PUP::er::operator() ( CMK_PUP_LONG_LONG *  a,
size_t  nItems 
) [inline]

Definition at line 280 of file pup.h.

References bytes(), and PUP::Tlonglong.

Here is the call graph for this function:

void PUP::er::operator() ( unsigned CMK_PUP_LONG_LONG *  a,
size_t  nItems 
) [inline]

Definition at line 282 of file pup.h.

References bytes(), and PUP::Tulonglong.

Here is the call graph for this function:

void PUP::er::operator() ( CmiInt16 a,
size_t  nItems 
) [inline]

Definition at line 286 of file pup.h.

References bytes(), and PUP::Tint128.

Here is the call graph for this function:

void PUP::er::operator() ( CmiUInt16 a,
size_t  nItems 
) [inline]

Definition at line 288 of file pup.h.

References bytes(), and PUP::Tuint128.

Here is the call graph for this function:

void PUP::er::operator() ( void **  a,
size_t  nItems,
void *  pointerSignature 
) [inline]

Definition at line 294 of file pup.h.

References bytes(), and PUP::Tpointer.

Here is the call graph for this function:

void PUP::er::operator() ( able **  a  )  [inline]

Definition at line 307 of file pup.h.

References object().

Here is the call graph for this function:

void PUP::er::operator() ( able a  ) 

Definition at line 58 of file pup_util.C.

References PUP::able::pup().

Here is the call graph for this function:

void PUP::er::comment ( const char *  message  )  [virtual]

void PUP::er::synchronize ( unsigned int  sync  )  [virtual]

A 32-bit "synchronization marker" (not human readable).

Some standard codes are listed under PUP::sync_....

Reimplemented in PUP_fmt, and PUP::toTextUtil.

Definition at line 72 of file pup_util.C.

Referenced by CpdPupMessage(), CpdList_message::pup(), CpdList_localQ::pup(), CpdList_localQ::pupSingleMessage(), and syncComment().

Here is the caller graph for this function:

void PUP::er::syncComment ( unsigned int  sync,
const char *  message = 0 
) [inline]

Insert a synchronization marker and comment into the stream.

Only applies if this PUP::er wants comments.

Definition at line 321 of file pup.h.

References comment(), hasComments(), message, and synchronize().

Referenced by CpdListBeginItem_impl(), object(), PUP::operator|(), CkQ< OBJ >::pup(), ArrayElement::pup(), PUP::PUP_stl_container(), PUP::PUP_stl_container_items(), PUP::PUP_stl_forward_list(), PUP::PUP_stl_map(), and pupCpd().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void PUP::er::bytes ( void *  p,
size_t  n,
size_t  itemSize,
dataType  t 
) [pure virtual]

void PUP::er::object ( able **  a  )  [virtual]

Reimplemented in PUP::toTextUtil.

Definition at line 520 of file pup_util.C.

References PUP_regEntry::ctor, isUnpacking(), PUP_regEntry::name, null_PUP_ID, PUP::able::PUP_ID::pup(), PUP_getRegEntry(), PUP::r, PUP::sync_begin_object, PUP::sync_end_object, and syncComment().

Referenced by PUP::toTextUtil::object(), and operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual size_t PUP::er::size ( void   )  const [inline, virtual]

void PUP::er::impl_startSeek ( PUP::seekBlock s  )  [virtual]

PUP::er seek implementation routines.

Reimplemented in PUP::zdisk, PUP::mem, PUP::disk, and PUP::wrap_er.

Definition at line 379 of file pup_util.C.

Referenced by PUP::wrap_er::impl_startSeek(), and PUP::seekBlock::seekBlock().

Here is the caller graph for this function:

size_t PUP::er::impl_tell ( seekBlock s  )  [virtual]

Reimplemented in PUP::zdisk, PUP::mem, PUP::disk, and PUP::wrap_er.

Definition at line 381 of file pup_util.C.

Referenced by PUP::seekBlock::endBlock(), PUP::wrap_er::impl_tell(), PUP::seekBlock::seek(), and PUP::seekBlock::seekBlock().

Here is the caller graph for this function:

void PUP::er::impl_seek ( seekBlock s,
size_t  off 
) [virtual]

Reimplemented in PUP::mem, PUP::disk, and PUP::wrap_er.

Definition at line 383 of file pup_util.C.

Referenced by PUP::seekBlock::endBlock(), PUP::wrap_er::impl_seek(), and PUP::seekBlock::seek().

Here is the caller graph for this function:

void PUP::er::impl_endSeek ( seekBlock s  )  [virtual]

Reimplemented in PUP::wrap_er.

Definition at line 385 of file pup_util.C.

Referenced by PUP::seekBlock::endBlock(), and PUP::wrap_er::impl_endSeek().

Here is the caller graph for this function:

virtual void PUP::er::pupCmiAllocBuf ( void **  msg  )  [inline, virtual]

Reimplemented in PUP_cmiAllocSizer, PUP_toCmiAllocMem, and PUP_fromCmiAllocMem.

Definition at line 347 of file pup.h.

References CmiAbort().

Here is the call graph for this function:

virtual void PUP::er::pupCmiAllocBuf ( void **  msg,
size_t  size 
) [inline, virtual]

Reimplemented in PUP_cmiAllocSizer, PUP_toCmiAllocMem, and PUP_fromCmiAllocMem.

Definition at line 354 of file pup.h.

References CmiAbort().

Here is the call graph for this function:


Field Documentation

unsigned int PUP::er::PUP_er_state [protected]


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

Generated on Mon Sep 21 08:34:10 2020 for Charm++ by  doxygen 1.5.5