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 ()
CmiBool isSizing (void) const
CmiBool isPacking (void) const
CmiBool isUnpacking (void) const
const char * typeString () const
unsigned int getStateFlags (void) const
void becomeDeleting (void)
CmiBool isDeleting (void) const
void becomeUserlevel (void)
CmiBool isUserlevel (void) const
void becomeRestarting (void)
CmiBool isRestarting (void) const
CmiBool 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() (CmiBool &v)
void operator() (CMK_PUP_LONG_LONG &v)
void operator() (unsigned CMK_PUP_LONG_LONG &v)
void operator() (void *&v, void *sig)
void operator() (signed char *a, int nItems)
void operator() (char *a, int nItems)
void operator() (short *a, int nItems)
void operator() (int *a, int nItems)
void operator() (long *a, int nItems)
void operator() (unsigned char *a, int nItems)
void operator() (unsigned short *a, int nItems)
void operator() (unsigned int *a, int nItems)
void operator() (unsigned long *a, int nItems)
void operator() (float *a, int nItems)
void operator() (double *a, int nItems)
void operator() (long double *a, int nItems)
void operator() (CmiBool *a, int nItems)
void operator() (CMK_PUP_LONG_LONG *a, int nItems)
void operator() (unsigned CMK_PUP_LONG_LONG *a, int nItems)
void operator() (void **a, int 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, int n, size_t itemSize, dataType t)=0
virtual void object (able **a)
virtual int size (void) const
virtual void impl_startSeek (seekBlock &s)
 PUP::er seek implementation routines.
virtual int impl_tell (seekBlock &s)
virtual void impl_seek (seekBlock &s, int off)
virtual void impl_endSeek (seekBlock &s)
virtual void pupCmiAllocBuf (void **msg)
virtual void pupCmiAllocBuf (void **msg, int 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 137 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 142 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 148 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 157 of file pup.h.

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

Definition at line 25 of file pup_util.C.

Member Function Documentation

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

Definition at line 162 of file pup.h.

References CmiFalse, CmiTrue, IS_SIZING, and PUP_er_state.

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

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

Definition at line 163 of file pup.h.

References CmiFalse, CmiTrue, IS_PACKING, and PUP_er_state.

Referenced by PUP::seekBlock::endBlock(), block::pup(), IDXL_Chunk::pup(), Boomarray< T >::pup(), ArmciStridedMsg::pup(), ArmciMsg::pup(), Cell::pup(), AmpiMsg::pup(), RouterStrategy::pup(), PipeBroadcastConverse::pup(), LogEntry::pup(), CkMarshalledNLBStatsMessage::pup(), CentralLB::pup(), redistributor2D::pup(), CkMigratable::pup(), PrioStreaming::pup(), PipeBroadcastStrategy::pup(), EachToManyMulticastStrategy::pup(), ComlibArrayInfo::pup(), receiver::pupCmmTable(), PUP::seekBlock::seek(), PUP::seekBlock::seekBlock(), and typeString().

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

Definition at line 164 of file pup.h.

References CmiFalse, CmiTrue, IS_UNPACKING, and PUP_er_state.

Referenced by CkPupArrayElementsData(), CkPupChareData(), CkPupGroupData(), CkPupMainChareData(), CkPupMessage(), CkPupNodeGroupData(), CkPupROData(), eventQueue::CommitEvents(), CtgPup(), ComlibManager::DelegatePointerPup(), object(), operator|(), RTH_StackFrame::pup(), RandomSequence< T >::pup(), CkSequence< T >::pup(), CkPagedVector< AmpiOtherElement >::pup(), CkPupAllocatePtr< T >::pup(), CkPupAlwaysAllocatePtr< T >::pup(), CkHashtableT< ComlibSectionHashKey, ComlibSectionHashObject * >::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(), 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(), CkCacheManager::pup(), Boomarray< T >::pup(), ArmciStridedMsg::pup(), ArmciMsg::pup(), Cell3D::pup(), Cell1D::pup(), Cell2D::pup(), Cell::pup(), NeighborMsg::pup(), win_obj::pup(), AmpiMsg::pup(), ATAReq::pup(), KeyvalPair::pup(), AmpiRequestList::pup(), ampi::pup(), CtgGlobalStruct::pup(), RouterStrategy::pup(), PipeBroadcastConverse::pup(), StrategyWrapper::pup(), MessageHolder::pup(), LogEntry::pup(), NullLB::pup(), CkMarshalledNLBStatsMessage::pup(), NLBStatsMsg::pup(), _LDCommDesc::pup(), LBDatabase::pup(), CkMarshalledCLBStatsMessage::pup(), CLBStatsMsg::pup(), CentralLB::pup(), BaseLB::ProcStats::pup(), BaseLB::LDStats::pup(), BaseLB::pup(), redistributor2D::pup(), TListCMsgBuffer::pup(), TListCWhenTrigger::pup(), CMsgBuffer::pup(), envelope::pup(), CkNodeReductionMgr::pup(), CkReductionMgr::pup(), CkMemCheckPT::pup(), CkLocMgr::pup(), CkMigratable::pup(), arrInfo::pup(), DefaultArrayMap::pup(), SNToTicket::pup(), ChareMlogData::pup(), RestoredLocalMap::pup(), MlogEntry::pup(), CkArrayReductionMgr::pup(), CkArrayBroadcaster::pup(), CkArrayReducer::pup(), CkArray::pup(), ArrayElement::pup(), VidBlock::pup(), CkSectionID::pup(), CProxy::pup(), Chare::pup(), CkMsgQ< CkReductionMsg >::pup(), PrioStreaming::pup(), PipeBroadcastStrategy::pup(), short_envelope::pup(), EachToManyMulticastStrategy::pup(), ComlibArrayInfo::pup(), ComlibGroupInfo::pup(), ComlibComRec::pup(), PUP_stl_container(), PUP_stl_map(), pupArrayElementsSkip(), CkCompactVec< T >::pupbase(), CkVec< CkZeroPtr< T, PUP_PTR > >::pupbase(), pupCkQ(), CkLocMgr::pupElementsFor(), PUPmarshall(), CkPagedVector< AmpiOtherElement >::pupPage(), FEM_Attribute::pupSingle(), TCharm::pupThread(), RTH_Runtime_pup(), PUP::seekBlock::seek(), and typeString().

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

Definition at line 33 of file pup_util.C.

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

Referenced by CkPupArrayElementsData(), CkPupGroupData(), CkPupMainChareData(), and CkPupNodeGroupData().

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

Definition at line 166 of file pup.h.

References PUP_er_state.

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

Definition at line 169 of file pup.h.

References IS_DELETING, and PUP_er_state.

Referenced by ElementDistributor::addLocation(), and CkLocMgr::emigrate().

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

Definition at line 170 of file pup.h.

References CmiFalse, CmiTrue, IS_DELETING, and PUP_er_state.

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

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

Definition at line 173 of file pup.h.

References IS_USERLEVEL, and PUP_er_state.

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

Definition at line 174 of file pup.h.

References CmiFalse, CmiTrue, IS_USERLEVEL, and PUP_er_state.

Referenced by ampi::pup().

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

Definition at line 177 of file pup.h.

References IS_RESTARTING, and PUP_er_state.

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

Definition at line 178 of file pup.h.

References CmiFalse, CmiTrue, IS_RESTARTING, and PUP_er_state.

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

Definition at line 180 of file pup.h.

References CmiFalse, CmiTrue, IS_COMMENTS, and PUP_er_state.

Referenced by syncComment().

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

Definition at line 183 of file pup.h.

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

Definition at line 185 of file pup.h.

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

Definition at line 187 of file pup.h.

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

Definition at line 188 of file pup.h.

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

Definition at line 189 of file pup.h.

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

Definition at line 190 of file pup.h.

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

Definition at line 191 of file pup.h.

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

Definition at line 192 of file pup.h.

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

Definition at line 193 of file pup.h.

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

Definition at line 194 of file pup.h.

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

Definition at line 195 of file pup.h.

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

Definition at line 197 of file pup.h.

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

Definition at line 199 of file pup.h.

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

Definition at line 201 of file pup.h.

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

Definition at line 202 of file pup.h.

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

Definition at line 204 of file pup.h.

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

Definition at line 208 of file pup.h.

References bytes(), and PUP::Tchar.

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

Definition at line 211 of file pup.h.

References bytes(), and PUP::Tchar.

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

Definition at line 214 of file pup.h.

References bytes(), and PUP::Tshort.

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

Definition at line 216 of file pup.h.

References bytes(), and PUP::Tint.

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

Definition at line 218 of file pup.h.

References bytes(), and PUP::Tlong.

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

Definition at line 222 of file pup.h.

References bytes(), and PUP::Tuchar.

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

Definition at line 224 of file pup.h.

References bytes(), and PUP::Tushort.

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

Definition at line 226 of file pup.h.

References bytes(), and PUP::Tuint.

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

Definition at line 228 of file pup.h.

References bytes(), and PUP::Tulong.

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

Definition at line 232 of file pup.h.

References bytes(), and PUP::Tfloat.

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

Definition at line 234 of file pup.h.

References bytes(), and PUP::Tdouble.

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

Definition at line 238 of file pup.h.

References bytes(), and PUP::Tlongdouble.

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

Definition at line 243 of file pup.h.

References bytes(), and PUP::Tbool.

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

Definition at line 247 of file pup.h.

References bytes(), and PUP::Tlonglong.

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

Definition at line 249 of file pup.h.

References bytes(), and PUP::Tulonglong.

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

Definition at line 255 of file pup.h.

References bytes(), and PUP::Tpointer.

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

Definition at line 266 of file pup.h.

References object().

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

Definition at line 27 of file pup_util.C.

References PUP::able::pup().

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

A descriptive (but entirely optional) human-readable comment field.

Reimplemented in PUP_fmt, PUP::toTextUtil, PUP::toTextFile, and PUP::fromTextFile.

Definition at line 30 of file pup_util.C.

Referenced by CpdList_arrayElements::add(), CpdList_arrayElementNames::add(), CpdList_object::add(), CpdList_objectNames::add(), CkPupMessage(), CpdPupMessage(), FEM_Mesh::pup(), FEM_Node::pup(), FEM_Entity::pup(), CpdList_introspect::pup(), CpdList_msgStack::pup(), CpdList_message::pup(), CpdList_localQ::pup(), pupChare(), CkLocMgr::pupElementsFor(), pupEntry(), pupReadonly(), pupReadonlyMsg(), CpdList_localQ::pupSingleMessage(), and syncComment().

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 41 of file pup_util.C.

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

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 280 of file pup.h.

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

Referenced by CpdListBeginItem_impl(), object(), operator|(), ArrayElement::pup(), PUP_stl_container(), PUP_stl_container_items(), PUP_stl_map(), pupCkQ(), and pupCpd().

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

Implemented in toProjectionsFile, fromProjectionsFile, toProjectionsGZFile, PUP_fmt, PUP::tozDisk, PUP::fromzDisk, PUP::sizer, PUP::toMem, PUP::fromMem, PUP::toDisk, PUP::fromDisk, PUP::toTextUtil, PUP::toTextFile, PUP::fromTextFile, PUP::xlater, PUP_cmiAllocSizer, PUP_toCmiAllocMem, PUP_fromCmiAllocMem, PUP_toPagedDisk, PUP_fromPagedDisk, PUP_toNetwork_sizer, PUP_toNetwork_pack, PUP_toNetwork_unpack, PUP_toNetwork4_sizer, PUP_toNetwork4_pack, and PUP_toNetwork4_unpack.

Referenced by PUP::xlater::bytes(), and operator()().

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

Reimplemented in PUP::toTextUtil.

Definition at line 412 of file pup_util.C.

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

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

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

Reimplemented in PUP::sizer, PUP::mem, PUP::sizerText, PUP::toText, PUP::wrap_er, PUP_toNetwork_sizer, PUP_toNetwork_pack, PUP_toNetwork_unpack, PUP_toNetwork4_sizer, PUP_toNetwork4_pack, and PUP_toNetwork4_unpack.

Definition at line 296 of file pup.h.

Referenced by PUP_fromPagedDisk::bytes(), PUP_toPagedDisk::bytes(), and PUP::wrap_er::size().

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 271 of file pup_util.C.

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

int PUP::er::impl_tell ( seekBlock &  s  )  [virtual]

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

Definition at line 273 of file pup_util.C.

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

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

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

Definition at line 275 of file pup_util.C.

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

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

Reimplemented in PUP::wrap_er.

Definition at line 277 of file pup_util.C.

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

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

Reimplemented in PUP_cmiAllocSizer, PUP_toCmiAllocMem, and PUP_fromCmiAllocMem.

Definition at line 306 of file pup.h.

References CmiAbort().

Referenced by short_envelope::pup().

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

Reimplemented in PUP_cmiAllocSizer, PUP_toCmiAllocMem, and PUP_fromCmiAllocMem.

Definition at line 311 of file pup.h.

References CmiAbort().

Field Documentation

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

Definition at line 153 of file pup.h.

Referenced by becomeDeleting(), becomeRestarting(), becomeUserlevel(), getStateFlags(), hasComments(), isDeleting(), isPacking(), isRestarting(), isSizing(), isUnpacking(), and isUserlevel().

The documentation for this class was generated from the following files:
Generated on Fri May 25 08:06:12 2012 for Charm++ by  doxygen 1.5.5