PPL Logo

eventID Class Reference

Unique identifier for a POSE event. More...

#include <eventID.h>

Collaboration diagram for eventID:

Collaboration graph
[legend]

Public Member Functions

 eventID ()
 Basic Constructor.
void init ()
 Init to default unused values.
void incEventID ()
 Get next value for eventID.
eventIDoperator= (const eventID &e)
 Assignment operator.
int getPE ()
 get source PE
int getControl ()
 get source control
void setControl (int ctrl)
 set source control
int operator== (const eventID &o)
 Equality comparison operator.
int operator<= (const eventID &o)
 Less than/equality comparison operator.
int operator< (const eventID &o)
 Less than comparison operator.
int operator>= (const eventID &o)
 Greater than/equality comparison operator.
int operator> (const eventID &o)
 Greater than comparison operator.
void dump ()
 Dump all data fields.
char * sdump (char *s)
char * sndump (char *s, size_t n)
void pup (class PUP::er &p)
 Pack/unpack/sizing operator.
void sanitize ()

Data Fields

unsigned int id
 Large number for identifier unique on creation PE.

Private Attributes

int pe
 PE identifier field ensures uniqueness across PEs.
int control
 Control field for ordering events with same timestamp.

Detailed Description

Unique identifier for a POSE event.

Definition at line 14 of file eventID.h.


Constructor & Destructor Documentation

eventID::eventID (  )  [inline]

Basic Constructor.

Definition at line 24 of file eventID.h.


Member Function Documentation

void eventID::init ( void   )  [inline]

Init to default unused values.

Definition at line 27 of file eventID.h.

References control, and pe.

Referenced by eventMsg::eventMsg().

Here is the caller graph for this function:

void eventID::incEventID (  )  [inline]

Get next value for eventID.

increments id field for this eventID

Definition at line 30 of file eventID.h.

Referenced by GetEventID().

Here is the caller graph for this function:

eventID& eventID::operator= ( const eventID e  )  [inline]

Assignment operator.

Definition at line 35 of file eventID.h.

References Converse::CkNumPes(), control, id, and pe.

Here is the call graph for this function:

int eventID::getPE (  )  [inline]

get source PE

Definition at line 40 of file eventID.h.

References pe.

Referenced by eventQueue::CommitEvents(), HeapNode::dumpString(), eventMsg::sanitize(), and eventMsg::Timestamp().

Here is the caller graph for this function:

int eventID::getControl (  )  [inline]

get source control

Definition at line 42 of file eventID.h.

References control.

void eventID::setControl ( int  ctrl  )  [inline]

set source control

Definition at line 44 of file eventID.h.

References control.

Referenced by eventMsg::SetSequenceNumber().

Here is the caller graph for this function:

int eventID::operator== ( const eventID o  )  [inline]

Equality comparison operator.

Definition at line 46 of file eventID.h.

References control, id, and pe.

int eventID::operator<= ( const eventID o  )  [inline]

Less than/equality comparison operator.

Provides a way to sort events by event ID

Definition at line 51 of file eventID.h.

References control.

int eventID::operator< ( const eventID o  )  [inline]

Less than comparison operator.

Provides a way to sort events by event ID

Definition at line 56 of file eventID.h.

References control.

int eventID::operator>= ( const eventID o  )  [inline]

Greater than/equality comparison operator.

Provides a way to sort events by event ID

Definition at line 61 of file eventID.h.

References control.

int eventID::operator> ( const eventID o  )  [inline]

Greater than comparison operator.

Provides a way to sort events by event ID

Definition at line 66 of file eventID.h.

References control.

void eventID::dump (  )  [inline]

Dump all data fields.

Definition at line 71 of file eventID.h.

References Converse::CkNumPes(), and pe.

Referenced by eventQueue::CommitEvents(), HeapNode::dump(), and CancelNode::dump().

Here is the call graph for this function:

Here is the caller graph for this function:

char* eventID::sdump ( char *  s  )  [inline]

Definition at line 75 of file eventID.h.

References pe.

char* eventID::sndump ( char *  s,
size_t  n 
) [inline]

Definition at line 76 of file eventID.h.

References pe, and snprintf().

Here is the call graph for this function:

void eventID::pup ( class PUP::er p  )  [inline]

Pack/unpack/sizing operator.

Definition at line 78 of file eventID.h.

References p, and pe.

Referenced by SpawnedEvent::pup(), Event::pup(), and CancelNode::pup().

Here is the caller graph for this function:

void eventID::sanitize (  )  [inline]

Definition at line 79 of file eventID.h.

References Converse::CkNumPes(), and pe.

Referenced by Event::sanitize().

Here is the call graph for this function:

Here is the caller graph for this function:


Field Documentation

int eventID::pe [private]

PE identifier field ensures uniqueness across PEs.

Definition at line 17 of file eventID.h.

Referenced by dump(), getPE(), init(), operator=(), operator==(), pup(), sanitize(), sdump(), and sndump().

int eventID::control [private]

Control field for ordering events with same timestamp.

Definition at line 19 of file eventID.h.

Referenced by getControl(), init(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), and setControl().

unsigned int eventID::id

Large number for identifier unique on creation PE.

Definition at line 22 of file eventID.h.

Referenced by eventQueue::CommitEvents(), HeapNode::dumpString(), operator=(), and operator==().


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

Generated on Mon Sep 21 08:23:22 2020 for Charm++ by  doxygen 1.5.5