plLogicModBase Class Reference

#include <plLogicModBase.h>

Inheritance diagram for plLogicModBase:

Public Types
enum	Flags {   kLocalElement, kReset, kTriggered, kOneShot,   kRequestingTrigger, kTypeActivator, kMultiTrigger }

Public Member Functions
	plLogicModBase ()
virtual	~plLogicModBase ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector< plMessage * >	getCommands () const
std::vector< plMessage * >	getCommands ()
void	addCommand (plMessage *cmd)
void	delCommand (size_t idx)
void	clearCommands ()
plNotifyMsg *	getNotify () const
bool	isDisabled () const
void	setNotify (plNotifyMsg *notify)
void	setDisabled (bool disabled)
bool	getLogicFlag (size_t flag) const
void	setLogicFlag (size_t flag, bool value)
Public Member Functions inherited from plSingleModifier
bool	getFlag (size_t flag) const
void	setFlag (size_t flag, bool value)
virtual size_t	getTargetsCount () const
virtual plKey	getTarget (size_t) const
virtual void	addTarget (plKey target)
virtual void	removeTarget (plKey)

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

Protected Attributes
std::vector< plMessage * >	fCommandList
hsBitVector	fLogicFlags
plNotifyMsg *	fNotify
bool	fDisabled
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

enum plLogicModBase::Flags

Enumerator:

kLocalElement
kReset
kTriggered
kOneShot
kRequestingTrigger
kTypeActivator
kMultiTrigger

Constructor & Destructor Documentation

plLogicModBase::plLogicModBase

(

)

virtual plLogicModBase::~plLogicModBase ( )

virtual

Member Function Documentation

void plLogicModBase::addCommand

(

plMessage *

cmd

)

void plLogicModBase::clearCommands

(

)

void plLogicModBase::delCommand

(

size_t

idx

)

const std::vector<plMessage*> plLogicModBase::getCommands

(

)

const

std::vector<plMessage*> plLogicModBase::getCommands

(

)

bool plLogicModBase::getLogicFlag

(

size_t

flag

)

const

plNotifyMsg* plLogicModBase::getNotify

(

)

const

virtual void plLogicModBase::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 plSingleModifier.

Reimplemented in plLogicModifier.

virtual void plLogicModBase::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 plSingleModifier.

Reimplemented in plLogicModifier.

bool plLogicModBase::isDisabled

(

)

const

virtual void plLogicModBase::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 plSingleModifier.

Reimplemented in plLogicModifier.

void plLogicModBase::setDisabled

(

bool

disabled

)

void plLogicModBase::setLogicFlag	(	size_t	flag,
		bool	value
	)

void plLogicModBase::setNotify

(

plNotifyMsg *

notify

)

virtual void plLogicModBase::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 plSingleModifier.

Reimplemented in plLogicModifier.

Member Data Documentation

std::vector<plMessage*> plLogicModBase::fCommandList

protected

bool plLogicModBase::fDisabled

protected

hsBitVector plLogicModBase::fLogicFlags

protected

plNotifyMsg* plLogicModBase::fNotify

protected

---

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

• core/PRP/Modifier/plLogicModBase.h