BaseEvent< S, A > Class Template Reference

The Class BaseEvent. More...

#include <BaseEvent.h>

Inheritance diagram for BaseEvent< S, A >:

List of all members.

Public Member Functions
	BaseEvent (const BaseEvent< S, A > &that)
	copy constructor copies over id as well
BaseEvent< S, A > &	operator= (const BaseEvent< S, A > &that)
	assignment operator assigns id as well
const std::string	detailedString () const
	Detailed string.
const std::string	toString () const
	a simpler string representation for debugging
const S &	getSendObj () const
	Gets the send obj.
const S &	getRecvObj () const
	Gets the recv obj.
const SimTime &	getSendTime () const
	Gets the send time.
const SimTime &	getRecvTime () const
	Gets the recv time.
const A &	getAction () const
	Gets the action.
size_t	getId () const
	Gets the id.
Protected Member Functions
	BaseEvent (size_t id, const S &sendObj, const S &recvObj, const A &action, const SimTime &sendTime, const SimTime &recvTime)
	Instantiates a new base event.
Private Attributes
size_t	id
	The id: not guaranteed to be unique.
S	sendObj
	The send obj.
S	recvObj
	The recv obj.
A	action
	The action to be performed on receipt of this event.
SimTime	sendTime
	The send time.
SimTime	recvTime
	The recv time.

---

Detailed Description

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

The Class BaseEvent.

Parameters:

	<S>	the type representing the simulation object
	<A>	the type representing the action to be performed on receipt of this event

---

Constructor & Destructor Documentation

template<typename S, typename A>

BaseEvent< S, A >::BaseEvent	(	size_t	id,
		const S &	sendObj,
		const S &	recvObj,
		const A &	action,
		const SimTime &	sendTime,
		const SimTime &	recvTime
	)			[inline, protected]

Instantiates a new base event.

Parameters:

	id,:	not guaranteed to be unique
	sendObj	the sending simulation obj
	recvObj	the receiving simulatio obj
	action	the action
	sendTime	the send time
	recvTime	the recv time

template<typename S, typename A>

BaseEvent< S, A >::BaseEvent

(

const BaseEvent< S, A > &

that

)

[inline]

copy constructor copies over id as well

---

Member Function Documentation

template<typename S, typename A>

const std::string BaseEvent< S, A >::detailedString

(

)

const [inline]

Detailed string.

Returns:

the string

Reimplemented in Event< S, A >.

template<typename S, typename A>

const A& BaseEvent< S, A >::getAction

(

)

const [inline]

Gets the action.

Returns:

the action

template<typename S, typename A>

size_t BaseEvent< S, A >::getId

(

)

const [inline]

Gets the id.

Returns:

the id

template<typename S, typename A>

const S& BaseEvent< S, A >::getRecvObj

(

)

const [inline]

Gets the recv obj.

Returns:

the recv obj

template<typename S, typename A>

const SimTime& BaseEvent< S, A >::getRecvTime

(

)

const [inline]

Gets the recv time.

Returns:

the recv time

template<typename S, typename A>

const S& BaseEvent< S, A >::getSendObj

(

)

const [inline]

Gets the send obj.

Returns:

the send obj

template<typename S, typename A>

const SimTime& BaseEvent< S, A >::getSendTime

(

)

const [inline]

Gets the send time.

Returns:

the send time

template<typename S, typename A>

BaseEvent<S, A>& BaseEvent< S, A >::operator=

(

const BaseEvent< S, A > &

that

)

[inline]

assignment operator assigns id as well

template<typename S, typename A>

const std::string BaseEvent< S, A >::toString

(

)

const [inline]

a simpler string representation for debugging

---

Member Data Documentation

template<typename S, typename A>

A BaseEvent< S, A >::action [private]

The action to be performed on receipt of this event.

template<typename S, typename A>

size_t BaseEvent< S, A >::id [private]

The id: not guaranteed to be unique.

template<typename S, typename A>

S BaseEvent< S, A >::recvObj [private]

The recv obj.

template<typename S, typename A>

SimTime BaseEvent< S, A >::recvTime [private]

The recv time.

template<typename S, typename A>

S BaseEvent< S, A >::sendObj [private]

The send obj.

template<typename S, typename A>

SimTime BaseEvent< S, A >::sendTime [private]

The send time.

---

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

• BaseEvent.h