cDelayChannel Class Reference
[Simulation core classes]

#include <cdelaychannel.h>

Inheritance diagram for cDelayChannel:

List of all members.

---

Detailed Description

Channel with propagation delay.

Constructors, destructor
	cDelayChannel (const char *name=NULL)
virtual	~cDelayChannel ()
static cDelayChannel *	create (const char *name)
Public Member Functions
Redefined cChannel member functions.
virtual bool	isTransmissionChannel () const
virtual double	getNominalDatarate () const
virtual simtime_t	calculateDuration (cMessage *msg) const
virtual simtime_t	getTransmissionFinishTime () const
virtual bool	isBusy () const
virtual void	forceTransmissionFinishTime (simtime_t t)
Setting and getting channel parameters.
virtual void	setDelay (double d)
virtual void	setDisabled (bool d)
virtual simtime_t	getDelay () const
virtual bool	isDisabled () const
Implementation methods
virtual void	initialize ()
virtual void	processMessage (cMessage *msg, simtime_t t, result_t &result)
Protected Member Functions
virtual void	handleParameterChange (const char *parname)

---

Constructor & Destructor Documentation

cDelayChannel::cDelayChannel

(

const char *

name = NULL

)

[inline, explicit]

Constructor.

This is only for internal purposes, and should not be used when creating channels dynamically; use the create() factory method instead.

virtual cDelayChannel::~cDelayChannel

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual void cDelayChannel::handleParameterChange

(

const char *

parname

)

[protected, virtual]

Called back when a parameter changes.

Redefined from cComponent.

Reimplemented from cComponent.

static cDelayChannel* cDelayChannel::create

(

const char *

name

)

[static]

Utility function for dynamic channel creation.

Equivalent to cChannelType::getDelayChannelType()->create(name).

virtual bool cDelayChannel::isTransmissionChannel

(

)

const [inline, virtual]

The cDelayChannel implementation of this method always returns false.

Implements cChannel.

virtual double cDelayChannel::getNominalDatarate

(

)

const [inline, virtual]

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

virtual simtime_t cDelayChannel::calculateDuration

(

cMessage *

msg

)

const [inline, virtual]

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

virtual simtime_t cDelayChannel::getTransmissionFinishTime

(

)

const [inline, virtual]

The cDelayChannel implementation of this method always returns zero.

Implements cChannel.

virtual bool cDelayChannel::isBusy

(

)

const [inline, virtual]

The cDelayChannel implementation of this method always returns false.

Reimplemented from cChannel.

virtual void cDelayChannel::forceTransmissionFinishTime

(

simtime_t

t

)

[inline, virtual]

The cDelayChannel implementation of this method does nothing.

Implements cChannel.

virtual void cDelayChannel::setDelay

(

double

d

)

[virtual]

Sets the propagation delay of the channel, in seconds.

virtual void cDelayChannel::setDisabled

(

bool

d

)

[virtual]

Disables or enables the channel.

virtual simtime_t cDelayChannel::getDelay

(

)

const [inline, virtual]

Returns the propagation delay of the channel, in seconds.

This method is equivalent to reading the "delay" parameter, via par("delay").

virtual bool cDelayChannel::isDisabled

(

)

const [inline, virtual]

Returns whether the channel is disabled.

This method is equivalent to reading the "disabled" parameter, via par("disabled"). A disabled channel discards all messages sent on it.

virtual void cDelayChannel::initialize

(

)

[virtual]

Initialization.

Reimplemented from cComponent.

virtual void cDelayChannel::processMessage	(	cMessage *	msg,
		simtime_t	t,
		result_t &	result
	)			[virtual]

This implementation delivers the message to the opposite gate with a delay.

Implements cChannel.

---

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

• cdelaychannel.h