Atlas_Objects_Entity_AdminEntityData (3) - Linux Manuals

Atlas_Objects_Entity_AdminEntityData: All classes and objects used for adminitrativive purposes.

NAME

Atlas::Objects::Entity::AdminEntityData - All classes and objects used for adminitrativive purposes.

SYNOPSIS

#include <Entity.h>

Inherits Atlas::Objects::Entity::RootEntityData.

Inherited by Atlas::Objects::Entity::AccountData, and Atlas::Objects::Entity::GameData.

Public Member Functions

virtual AdminEntityData * 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 AdminEntityData * 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 AdminEntityData * alloc ()
Allocate a new instance of this class, using an existing instance if available.
static AdminEntityData * getDefaultObjectInstance ()
Get the reference object that contains the default values for attributes of instances of this class.

Protected Member Functions

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

Detailed Description

All classes and objects used for adminitrativive purposes.

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

Member Function Documentation

static AdminEntityData* Atlas::Objects::Entity::AdminEntityData::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::RootEntityData.

Reimplemented in Atlas::Objects::Entity::AccountData, Atlas::Objects::Entity::PlayerData, Atlas::Objects::Entity::AdminData, and Atlas::Objects::Entity::GameData.

virtual void Atlas::Objects::Entity::AdminEntityData::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::RootEntityData.

Reimplemented in Atlas::Objects::Entity::AccountData, Atlas::Objects::Entity::PlayerData, Atlas::Objects::Entity::AdminData, and Atlas::Objects::Entity::GameData.

virtual AdminEntityData* Atlas::Objects::Entity::AdminEntityData::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::RootEntityData.

Reimplemented in Atlas::Objects::Entity::AccountData, Atlas::Objects::Entity::PlayerData, Atlas::Objects::Entity::AdminData, and Atlas::Objects::Entity::GameData.

static AdminEntityData* Atlas::Objects::Entity::AdminEntityData::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::RootEntityData.

Reimplemented in Atlas::Objects::Entity::AccountData, Atlas::Objects::Entity::PlayerData, Atlas::Objects::Entity::AdminData, and Atlas::Objects::Entity::GameData.

Author

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