---

strmod::strmod::InfiniteModule Class Reference

Sends a particular chunk repeatedly forever. Eats any chunk sent to it. More...

#include <StrMod/InfiniteModule.h>

Inheritance diagram for strmod::strmod::InfiniteModule:

[legend]List of all members.

Public Methods
	InfiniteModule (const StrChunkPtr &chnk)
	Construct given a chunk to repeatedly send.
	InfiniteModule ()
	Destroy an InfiniteModule.
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 Plug *	i_MakePlug (int side)
	Makes a plug on the given side.
Friends
class	IPlug

---

Detailed Description

Sends a particular chunk repeatedly forever. Eats any chunk sent to it.

This strongly resembles a /dev/zero where you decide what comes out instead of an infinite string of zeros.

Definition at line 43 of file InfiniteModule.h.

---

Constructor & Destructor Documentation

strmod::strmod::InfiniteModule::InfiniteModule (  const StrChunkPtr &    chnk )

Construct given a chunk to repeatedly send. Parameters: chnk  The chunk to repeatedly send. Definition at line 36 of file InfiniteModule.cxx.

---

Member Function Documentation

int strmod::strmod::InfiniteModule::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 102 of file InfiniteModule.h.

bool strmod::strmod::InfiniteModule::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 56 of file InfiniteModule.cxx.

virtual const lcore::ClassIdent* strmod::strmod::InfiniteModule::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 67 of file InfiniteModule.h.

StreamModule::Plug * strmod::strmod::InfiniteModule::i_MakePlug (  int    side )  [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 72 of file InfiniteModule.cxx.

StreamModule::Plug * strmod::strmod::InfiniteModule::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 112 of file InfiniteModule.h.

---

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

• InfiniteModule.h
• InfiniteModule.cxx

---