We support a
Software Patent Free Europe.

ot::GroupGateNode Class Reference
[Common Classes]

A GroupGateNode is an EventGenerator node that . More...

#include <GroupGateNode.h>

Inheritance diagram for ot::GroupGateNode:

[legend]Collaboration diagram for ot::GroupGateNode:


Public Member Functions
virtual int	isEventGenerator ()
virtual void	onEventGenerated (Event &event, Node &generator)
Protected Member Functions
	GroupGateNode (const char name, GroupGateGroup owner)
	~GroupGateNode ()
void	setNumber (int num)
int	getNumber ()
void	addNeighbor (const char *neighbor)
bool	isActive ()
void	activate ()
void	deactivate ()
const char *	getGroupGateName ()
Private Attributes
int	Number
GroupGateGroup *	Owner
std::string	Name
NeighborsVector	Neighbors
NeighborPtrsVector	NeighborPtrs
bool	IsActive
Friends
class	GroupGateModule
class	GroupGateGroup

Detailed Description

A GroupGateNode is an EventGenerator node that .

.. TO DO

Author:: Michael Knapp

Definition at line 121 of file GroupGateNode.h.

Constructor & Destructor Documentation

ot::GroupGateNode::GroupGateNode	(	const char *	name,
		GroupGateGroup *	owner
	)			`[protected]`

constructor method.

It sets initial values for the timeout.

Definition at line 63 of file GroupGateNode.cxx.

References IsActive, Name, Number, and Owner.

ot::GroupGateNode::~GroupGateNode ( ) [protected]

Definition at line 71 of file GroupGateNode.cxx.

References Neighbors.

Member Function Documentation

void ot::GroupGateNode::activate ( ) [protected]

Definition at line 101 of file GroupGateNode.cxx.

References IsActive.

Referenced by ot::GroupGateModule::activateGroupGate(), and onEventGenerated().

void ot::GroupGateNode::addNeighbor ( const char * neighbor ) [protected]

Definition at line 89 of file GroupGateNode.cxx.

References Neighbors.

Referenced by ot::GroupGateModule::createNode().

void ot::GroupGateNode::deactivate ( ) [protected]

Definition at line 107 of file GroupGateNode.cxx.

References IsActive.

const char * ot::GroupGateNode::getGroupGateName ( ) [protected]

Definition at line 113 of file GroupGateNode.cxx.

References Name.

int ot::GroupGateNode::getNumber ( ) [protected]

Definition at line 83 of file GroupGateNode.cxx.

References Number.

Referenced by ot::GroupGateGroup::notifyActiveGate().

bool ot::GroupGateNode::isActive ( ) [protected]

Definition at line 95 of file GroupGateNode.cxx.

References IsActive.

Referenced by onEventGenerated().

virtual int ot::GroupGateNode::isEventGenerator ( ) [inline, virtual]

tests for EventGenerator interface being implemented.

This has to be overriden in classes that subclass EventGenerator. Due to inheritance raints it cannot be done automatically.

Returns:: a pointer to the EventGenerator interface, or NULL if it is not implemented

Reimplemented from ot::Node.

Definition at line 146 of file GroupGateNode.h.

void ot::GroupGateNode::onEventGenerated	(	Event &	event,
		Node &	generator
	)			`[virtual]`

this method notifies the object that a new event was generated.

It is called by an EventGenerator.

Parameters:

	event	reference to the new event. Do not change the event values, make a copy and change that !
	generator	reference to the EventGenerator object that notified the EventObserver.

Reimplemented from ot::Node.

Definition at line 119 of file GroupGateNode.cxx.

References activate(), ot::GroupGateGroup::deactivateAll(), ot::GroupGateGroup::getNode(), isActive(), ot::Node::isNodePort(), NeighborPtrs, Neighbors, ot::GroupGateGroup::notifyActiveGate(), Owner, ot::GroupGateGroup::setActiveGroupGate(), and ot::Node::updateObservers().