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

#include <plAgeLinkInfo.h>

Inheritance diagram for plAgeInfoStruct:
plCreatable

Public Types

enum  {
  kHasAgeFilename = 0x1, kHasAgeInstanceName = 0x2, kHasAgeInstanceGuid = 0x4, kHasAgeUserDefinedName = 0x8,
  kHasAgeSequenceNumber = 0x10, kHasAgeDescription = 0x20, kHasAgeLanguage = 0x40
}

Public Member Functions

 plAgeInfoStruct ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)
bool isEmpty ()
void clear ()
plString getAgeFilename () const
plString getAgeInstanceName () const
const plUuidgetAgeInstanceGuid () const
plString getAgeUserDefinedName () const
plString getAgeDescription () const
int getAgeSequenceNumber () const
int getAgeLanguage () const
void setAgeFilename (plString name)
void setAgeInstanceName (plString name)
void setAgeInstanceGuid (const plUuid &guid)
void setAgeUserDefinedName (plString name)
void setAgeDescription (plString desc)
void setAgeSequenceNumber (int seq)
void setAgeLanguage (int lang)
void clearAgeFilename ()
void clearAgeInstanceName ()
void clearAgeInstanceGuid ()
void clearAgeUserDefinedName ()
void clearAgeDescription ()
void clearAgeSequenceNumber ()
void clearAgeLanguage ()
bool hasAgeFilename () const
bool hasAgeInstanceName () const
bool hasAgeInstanceGuid () const
bool hasAgeUserDefiniedName () const
bool hasAgeDescription () const
bool hasAgeSequenceNumber () const
bool hasAgeLanguage () const
- 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)

Protected Member Functions

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

Protected Attributes

unsigned char fFlags
plString fAgeFilename
plString fAgeInstanceName
plUuid fAgeInstanceGuid
plString fAgeUserDefinedName
plString fAgeDescription
int fAgeSequenceNumber
int fAgeLanguage

Member Enumeration Documentation

anonymous enum
Enumerator:
kHasAgeFilename 
kHasAgeInstanceName 
kHasAgeInstanceGuid 
kHasAgeUserDefinedName 
kHasAgeSequenceNumber 
kHasAgeDescription 
kHasAgeLanguage 

Constructor & Destructor Documentation

plAgeInfoStruct::plAgeInfoStruct ( )

Member Function Documentation

void plAgeInfoStruct::clear ( )
void plAgeInfoStruct::clearAgeDescription ( )
void plAgeInfoStruct::clearAgeFilename ( )
void plAgeInfoStruct::clearAgeInstanceGuid ( )
void plAgeInfoStruct::clearAgeInstanceName ( )
void plAgeInfoStruct::clearAgeLanguage ( )
void plAgeInfoStruct::clearAgeSequenceNumber ( )
void plAgeInfoStruct::clearAgeUserDefinedName ( )
plString plAgeInfoStruct::getAgeDescription ( ) const
plString plAgeInfoStruct::getAgeFilename ( ) const
const plUuid& plAgeInfoStruct::getAgeInstanceGuid ( ) const
plString plAgeInfoStruct::getAgeInstanceName ( ) const
int plAgeInfoStruct::getAgeLanguage ( ) const
int plAgeInfoStruct::getAgeSequenceNumber ( ) const
plString plAgeInfoStruct::getAgeUserDefinedName ( ) const
bool plAgeInfoStruct::hasAgeDescription ( ) const
bool plAgeInfoStruct::hasAgeFilename ( ) const
bool plAgeInfoStruct::hasAgeInstanceGuid ( ) const
bool plAgeInfoStruct::hasAgeInstanceName ( ) const
bool plAgeInfoStruct::hasAgeLanguage ( ) const
bool plAgeInfoStruct::hasAgeSequenceNumber ( ) const
bool plAgeInfoStruct::hasAgeUserDefiniedName ( ) const
virtual void plAgeInfoStruct::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 plAgeInfoStruct::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.

bool plAgeInfoStruct::isEmpty ( )
virtual void plAgeInfoStruct::prcParse ( const pfPrcTag tag,
plResManager mgr 
)
virtual

Read this creatable from a PRC tag. If any keys are parsed, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

virtual void plAgeInfoStruct::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 plAgeInfoStruct::setAgeDescription ( plString  desc)
void plAgeInfoStruct::setAgeFilename ( plString  name)
void plAgeInfoStruct::setAgeInstanceGuid ( const plUuid guid)
void plAgeInfoStruct::setAgeInstanceName ( plString  name)
void plAgeInfoStruct::setAgeLanguage ( int  lang)
void plAgeInfoStruct::setAgeSequenceNumber ( int  seq)
void plAgeInfoStruct::setAgeUserDefinedName ( plString  name)
virtual void plAgeInfoStruct::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

plString plAgeInfoStruct::fAgeDescription
protected
plString plAgeInfoStruct::fAgeFilename
protected
plUuid plAgeInfoStruct::fAgeInstanceGuid
protected
plString plAgeInfoStruct::fAgeInstanceName
protected
int plAgeInfoStruct::fAgeLanguage
protected
int plAgeInfoStruct::fAgeSequenceNumber
protected
plString plAgeInfoStruct::fAgeUserDefinedName
protected
unsigned char plAgeInfoStruct::fFlags
protected

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