libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plLogicModifier Class Reference

#include <plLogicModifier.h>

Inheritance diagram for plLogicModifier:
plLogicModBase plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 plLogicModifier ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getConditions () const
std::vector< plKey > & getConditions ()
void addCondition (plKey cond)
void delCondition (size_t idx)
void clearConditions ()
unsigned int getCursor () const
plKey getParent () const
void setCursor (unsigned int cursor)
void setParent (plKey parent)
- Public Member Functions inherited from plLogicModBase
 plLogicModBase ()
virtual ~plLogicModBase ()
const std::vector< plMessage * > getCommands () const
std::vector< plMessage * > getCommands ()
void addCommand (plMessage *cmd)
void delCommand (size_t idx)
void clearCommands ()
plNotifyMsggetNotify () 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< plKeyfConditionList
unsigned int fMyCursor
plKey fParent
- Protected Attributes inherited from plLogicModBase
std::vector< plMessage * > fCommandList
hsBitVector fLogicFlags
plNotifyMsgfNotify
bool fDisabled
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

Additional Inherited Members

- Public Types inherited from plLogicModBase
enum  Flags {
  kLocalElement, kReset, kTriggered, kOneShot,
  kRequestingTrigger, kTypeActivator, kMultiTrigger
}

Constructor & Destructor Documentation

plLogicModifier::plLogicModifier ( )

Member Function Documentation

void plLogicModifier::addCondition ( plKey  cond)
void plLogicModifier::clearConditions ( )
void plLogicModifier::delCondition ( size_t  idx)
const std::vector<plKey>& plLogicModifier::getConditions ( ) const
std::vector<plKey>& plLogicModifier::getConditions ( )
unsigned int plLogicModifier::getCursor ( ) const
plKey plLogicModifier::getParent ( ) const
virtual void plLogicModifier::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 plLogicModBase.

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

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

void plLogicModifier::setCursor ( unsigned int  cursor)
void plLogicModifier::setParent ( plKey  parent)
virtual void plLogicModifier::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 plLogicModBase.

Member Data Documentation

std::vector<plKey> plLogicModifier::fConditionList
protected
unsigned int plLogicModifier::fMyCursor
protected
plKey plLogicModifier::fParent
protected

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