---

strmod::strmod::EchoModule Class Reference

This module echoes everything that comes in. More...

#include <StrMod/EchoModule.h>

Inheritance diagram for strmod::strmod::EchoModule:

[legend]List of all members.

Public Methods
virtual int	AreYouA (const lcore::ClassIdent &cid) const
	Asks if a class is of a particular type, or publicly derived from that type.
virtual bool	canCreate (int side=0) const
	Can a plug be created on the given side?
Plug *	makePlug (int side=0)
	Attempts to create a plug on the given side.
virtual bool	ownsPlug (const Plug *plug) const
	Does the module own this plug?
virtual bool	deletePlug (Plug *plug)
	Please delete this plug.
Static Public Attributes
const STR_ClassIdent	identifier
	A unique identifier for this class.
Protected Methods
virtual const lcore::ClassIdent *	i_GetIdent () const
	Returns the class identifier for the class the object actually is.
virtual void	plugDisconnected (Plug *plug)
	Called whenever a plug is disconnected.
virtual Plug *	i_MakePlug (int side)
	Makes a plug on the given side.
Friends
class	EPlug

---

Detailed Description

This module echoes everything that comes in.

Everything that is written to its one plug is read from that same plug.

Definition at line 52 of file EchoModule.h.

---

Member Function Documentation

int strmod::strmod::EchoModule::AreYouA (  const lcore::ClassIdent &    cid )  const [inline, virtual]

Asks if a class is of a particular type, or publicly derived from that type. Overriden in every derived class (with a static identifier member) to compare against the identifier, then call the AreYouA methods of all the superclasses. Parameters: cid  Usually <class>::identifier for the class you want to ask if the object is an instance of. Reimplemented from strmod::strmod::StreamModule. Definition at line 114 of file EchoModule.h.

bool strmod::strmod::EchoModule::deletePlug (  Plug *    plug )  [virtual]

Please delete this plug. Modules are supposed to own plugs, so you aren't supposed to delete them yourself. Returns false on failure. Failure could happen because module does not own the plug. Implements strmod::strmod::StreamModule. Definition at line 45 of file EchoModule.cxx.

virtual const lcore::ClassIdent* strmod::strmod::EchoModule::i_GetIdent (    )  const [inline, protected, virtual]

Returns the class identifier for the class the object actually is. Should always be overridden in any class that has a static identifier member. Reimplemented from strmod::strmod::StreamModule. Definition at line 70 of file EchoModule.h.

EchoModule::Plug * strmod::strmod::EchoModule::i_MakePlug (  int    side )  [inline, protected, virtual]

Makes a plug on the given side. Guaranteed to never be called if canCreate would return false. Must NEVER return 0 (NULL). Implements strmod::strmod::StreamModule. Definition at line 134 of file EchoModule.h.

StreamModule::Plug * strmod::strmod::EchoModule::makePlug (  int    side = 0 )  [inline]

Attempts to create a plug on the given side. When writing a derived class, your MakePlug function should ALWAYS call CanCreate first before calling i_MakePlug. Returns 0 (NULL) on failure. Only fails if CanCreate would return false. Reimplemented from strmod::strmod::StreamModule. Definition at line 124 of file EchoModule.h.

void strmod::strmod::EchoModule::plugDisconnected (  Plug *    plug )  [protected, virtual]

Called whenever a plug is disconnected. This function isn't called when a plug is disconnected as a result of its destructor being called. This is used to provide a hook to do what you think you should do when a plug is disconnected. It calls the pdstrategy_ by default, if there is one. Reimplemented from strmod::strmod::StreamModule. Definition at line 59 of file EchoModule.cxx.

---

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

• EchoModule.h
• EchoModule.cxx

---