ChSAP Class Reference

#include <chsap.h>

Inheritance diagram for ChSAP:

[legend]Collaboration diagram for ChSAP:


Public Member Functions
	ChSAP ()
virtual	~ChSAP ()
virtual int	command (int argc, const char const argv)
void	sendDown (Packet *p, double delay)
virtual void	sendUp (Packet *p, double delay)
void	handle (Event *e)
Position *	getPosition ()
Protected Attributes
NodeCore *	nodeCorePtr_
ChannelModule *	channel_

Detailed Description

The ChSAP class is a SAP which is used to connect a modules to a channel-module. It has tracing functionality, thus it could trace the packets which pass through.

See also:: ChannelModule, Module, NodeCore, Position

Definition at line 52 of file chsap.h.

Constructor & Destructor Documentation

ChSAP::ChSAP ( )

ChSAP constructor

Definition at line 45 of file chsap.cc.

ChSAP::~ChSAP ( ) [virtual]

ChSAP destructor

Definition at line 49 of file chsap.cc.

Member Function Documentation

int ChSAP::command	(	int	argc,
		const char const	argv
	)			`[virtual]`

TCL command interpreter. It implements the following OTcl methods:

module <module instance>: initializes the upModule_ pointer to the given module
channel <module instance>: initializes the downModule_ pointer to the given module
nodeCore <Node core instance>: initializes the nodeCorePtr_ class attribute

Moreover it inherits all the OTcl method of SAP

Parameters:

	argc	number of arguments in argv
	argv	array of strings which are the comand parameters (Note that argv[0] is the name of the object)

Returns:: TCL_OK or TCL_ERROR whether the command has been dispatched succesfully or no

See also:: NodeCore

Reimplemented from SAP.

Definition at line 54 of file chsap.cc.

References channel_, SAP::command(), SAP::downModule_, nodeCorePtr_, and SAP::upModule_.

Here is the call graph for this function:

void ChSAP::sendDown	(	Packet *	p,
		double	delay
	)			`[virtual]`

Overload of the SAP method: send a packet to the channel adding a delay if it is neccessary (it does not send the module id of the sender) Note: this method sets the direction of the packet to DOWN

Parameters:

	p	a pointer to the packet which has to send down
	delay	the delivery delay (it must be greater or equal 0)

Reimplemented from SAP.

Definition at line 97 of file chsap.cc.

References channel_, ConnectorTrace::debug_, ConnectorTrace::depth_, SAP::depthDown_, DOWN, ChannelModule::recv(), and SAP::trace().

Here is the call graph for this function:

void ChSAP::sendUp	(	Packet *	p,
		double	delay
	)			`[virtual]`

Overload of the SAP method: send a packet to the up module adding a delay if it is neccessary. Note: this method sets the direction of the packet to UP

Parameters: