plMsgForwarder Class Reference

#include <plMsgForwarder.h>

Inheritance diagram for plMsgForwarder:

Public Member Functions
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector< plKey > &	getForwardKeys () const
std::vector< plKey > &	getForwardKeys ()
void	addForwardKey (plKey fwd)
void	delForwardKey (size_t idx)
void	clearForwardKeys ()
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
Public Member Functions inherited from plCreatable
	plCreatable ()
virtual	~plCreatable ()
virtual short	ClassIndex () const =0
short	ClassIndex (PlasmaVer ver) const
virtual const char *	ClassName () const
virtual bool	ClassInstance (short) const
virtual bool	isStub () const
virtual void	prcWrite (pfPrcHelper *prc)
virtual void	prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
std::vector< plKey >	fForwardKeys

Member Function Documentation

void plMsgForwarder::addForwardKey

(

plKey

fwd

)

void plMsgForwarder::clearForwardKeys

(

)

void plMsgForwarder::delForwardKey

(

size_t

idx

)

const std::vector<plKey>& plMsgForwarder::getForwardKeys

(

)

const

std::vector<plKey>& plMsgForwarder::getForwardKeys

(

)

virtual void plMsgForwarder::IPrcParse ( const pfPrcTag *  tag, plResManager *  mgr  )

protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from hsKeyedObject.

virtual void plMsgForwarder::IPrcWrite ( pfPrcHelper *  prc )

protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from hsKeyedObject.

virtual void plMsgForwarder::read ( hsStream *  , plResManager *    )

virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from hsKeyedObject.

virtual void plMsgForwarder::write ( hsStream *  , plResManager *    )

virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from hsKeyedObject.

Member Data Documentation

std::vector<plKey> plMsgForwarder::fForwardKeys

protected

---

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

• core/PRP/Message/plMsgForwarder.h