---

strmod::strmod::PassThrough Class Reference

This is a StreamProcessor that does nothing. More...

#include <StrMod/PassThrough.h>

Inheritance diagram for strmod::strmod::PassThrough:

[legend]List of all members.

Public Methods
	PassThrough ()
	Doesn't do anything, so doesn't need much in its constructor.
virtual int	AreYouA (const lcore::ClassIdent &cid) const
	Asks if a class is of a particular type, or publicly derived from that type.
Static Public Attributes
const STR_ClassIdent	identifier
	Globally 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	processIncoming ()
	Do something with your incoming_ data.

---

Detailed Description

This is a StreamProcessor that does nothing.

Oftentimes, when using a ProcessorModule, you will want no processing to be done in one direction or the other. That's what PassThrough StreamProcessor is for.

Definition at line 48 of file PassThrough.h.

---

Member Function Documentation

int strmod::strmod::PassThrough::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::StreamProcessor. Definition at line 70 of file PassThrough.h.

virtual const lcore::ClassIdent* strmod::strmod::PassThrough::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::StreamProcessor. Definition at line 60 of file PassThrough.h.

void strmod::strmod::PassThrough::processIncoming (    )  [inline, protected, virtual]

Do something with your incoming_ data. Precondition: (incoming_ && !outoing_ready_) will always be true when entering this function, meaning that incoming_ points at a valid chunk. Postcondition: A post condition of this function is (!incoming_ || (outgoing_ready_ && outgoing_)). Implements strmod::strmod::StreamProcessor. Definition at line 75 of file PassThrough.h.

---

Member Data Documentation

const STR_ClassIdent strmod::strmod::PassThrough::identifier [static]

Globally unique identifier for this class. Every class that might need to be identified should have a public static const identifier object in it. Reimplemented from strmod::strmod::StreamProcessor.

---

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

• PassThrough.h
• PassThrough.cxx

---