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

#include <plCreatableListHelper.h>

Inheritance diagram for plCreatableListHelper:
plCreatable

Public Types

enum  Flags { kWantCompression = (1<<0), kCompressed = (1<<1), kWritten = (1<<2) }

Public Member Functions

 plCreatableListHelper ()
virtual ~plCreatableListHelper ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
uint8_t getFlags () const
void setFlags (uint8_t flags)
std::map< uint16_t,
plCreatable * > & 
getCreatables ()
const std::map< uint16_t,
plCreatable * > & 
getCreatables () const
void clearCreatables ()
- 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

uint8_t fFlags
std::map< uint16_t, plCreatable * > fCreatables

Member Enumeration Documentation

Enumerator:
kWantCompression 
kCompressed 
kWritten 

Constructor & Destructor Documentation

plCreatableListHelper::plCreatableListHelper ( )
virtual plCreatableListHelper::~plCreatableListHelper ( )
virtual

Member Function Documentation

void plCreatableListHelper::clearCreatables ( )
std::map<uint16_t, plCreatable*>& plCreatableListHelper::getCreatables ( )
const std::map<uint16_t, plCreatable*>& plCreatableListHelper::getCreatables ( ) const
uint8_t plCreatableListHelper::getFlags ( ) const
virtual void plCreatableListHelper::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 plCreatable.

virtual void plCreatableListHelper::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().

Implements plCreatable.

virtual void plCreatableListHelper::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 plCreatable.

void plCreatableListHelper::setFlags ( uint8_t  flags)
virtual void plCreatableListHelper::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 plCreatable.

Member Data Documentation

std::map<uint16_t, plCreatable*> plCreatableListHelper::fCreatables
protected
uint8_t plCreatableListHelper::fFlags
protected

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