Event< S, A > Class Template Reference

#include <Event.h>

Inheritance diagram for Event< S, A >:
BaseEvent< S, A >

List of all members.

Public Types

enum  Type { REGULAR_EVENT, NULL_EVENT }
 

An event can be a NULL_EVENT.

More...

Public Member Functions

const TypegetType () const
const std::string detailedString () const

Private Member Functions

 Event (size_t id, const S &sendObj, const S &recvObj, const A &action, const Type type, const SimTime &sendTime, const SimTime &recvTime)
 Constructor.

Private Attributes

Type type
 type of the event

Friends

class AbstractSimObject

Detailed Description

template<typename S, typename A>
class Event< S, A >

Description

Represents the basic structure an unordered Event


Member Enumeration Documentation

template<typename S , typename A >
enum Event::Type

An event can be a NULL_EVENT.

See also:
Chandy-Misra's paper or a normal REGULAR_EVENT
Enumerator:
REGULAR_EVENT 
NULL_EVENT 

Constructor & Destructor Documentation

template<typename S , typename A >
Event< S, A >::Event ( size_t  id,
const S sendObj,
const S recvObj,
const A &  action,
const Type  type,
const SimTime sendTime,
const SimTime recvTime 
) [inline, private]

Constructor.

Parameters:
id,: not guaranteed to be unique. Only events from same sender must have unique id's
sendObj,: the sending node in the graph
recvObj,: the receiving node in the graph
action,: a user defined object describing the action to be performed on the receipt of this event
type,: the type of the event
See also:
EventType
Parameters:
sendTime,: sending time
recvTime,: receiving time

Member Function Documentation

template<typename S , typename A >
const std::string Event< S, A >::detailedString (  )  const [inline]
Returns:
detailed string representaion

Reimplemented from BaseEvent< S, A >.

template<typename S , typename A >
const Type& Event< S, A >::getType (  )  const [inline]
Returns:
the type of this Event

Friends And Related Function Documentation

template<typename S , typename A >
friend class AbstractSimObject [friend]

Member Data Documentation

template<typename S , typename A >
Type Event< S, A >::type [private]

type of the event


The documentation for this class was generated from the following file:
Generated on Tue Aug 2 11:51:27 2011 for Galois by  doxygen 1.6.3