Atlas::Objects::Entity::AdminData

Section: C Library Functions (3)
Updated: 24 Jul 2009
Index Return to Main Contents
 

NAME

Atlas::Objects::Entity::AdminData - Privileged accounts.

 

SYNOPSIS


#include <Entity.h>

Inherits Atlas::Objects::Entity::AccountData.

 

Public Member Functions


virtual AdminData * copy () const
Copy this object.
virtual bool instanceOf (int classNo) const
Is this instance of some class?
virtual void iterate (int &current_class, std::string &attr) const
Iterate over the attributes of this instance.
virtual void free ()
Free an instance of this class, returning it to the memory pool.
virtual AdminData * getDefaultObject ()
Get the reference object that contains the default values for attributes of instances of the same class as this object.  

Static Public Member Functions


static AdminData * alloc ()
Allocate a new instance of this class, using an existing instance if available.
static AdminData * getDefaultObjectInstance ()
Get the reference object that contains the default values for attributes of instances of this class.  

Protected Member Functions


AdminData (AdminData *defaults=NULL)
Construct a AdminData class definition.
virtual ~AdminData ()
Default destructor.  

Detailed Description

Privileged accounts.

Later in hierarchy tree objtype changes to 'object' when actual game objects are made.  

Member Function Documentation

 

static AdminData* Atlas::Objects::Entity::AdminData::alloc () [static]

Allocate a new instance of this class, using an existing instance if available.

This is the key function for implementing the memory pool for the Atlas::Objects API.

Reimplemented from Atlas::Objects::Entity::AccountData.  

virtual void Atlas::Objects::Entity::AdminData::free () [virtual]

Free an instance of this class, returning it to the memory pool.

This function in combination with alloc() handle the memory pool.

Reimplemented from Atlas::Objects::Entity::AccountData.  

virtual AdminData* Atlas::Objects::Entity::AdminData::getDefaultObject () [virtual]

Get the reference object that contains the default values for attributes of instances of the same class as this object.

Returns:

a pointer to the default object.

Reimplemented from Atlas::Objects::Entity::AccountData.  

static AdminData* Atlas::Objects::Entity::AdminData::getDefaultObjectInstance () [static]

Get the reference object that contains the default values for attributes of instances of this class.

Returns:

a pointer to the default object.

Reimplemented from Atlas::Objects::Entity::AccountData.

 

Author

Generated automatically by Doxygen for Atlas-C++ from the source code.