Atlas_Objects_Operation_PerceptionData (3) - Linux Manuals

Atlas_Objects_Operation_PerceptionData: Character perceives something.

NAME

Atlas::Objects::Operation::PerceptionData - Character perceives something.

SYNOPSIS

#include <Operation.h>

Inherits Atlas::Objects::Operation::InfoData.

Inherited by Atlas::Objects::Operation::FeelData, Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::SmellData, and Atlas::Objects::Operation::SoundData.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Character perceives something.

Member Function Documentation

static PerceptionData* Atlas::Objects::Operation::PerceptionData::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::Operation::InfoData.

Reimplemented in Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::SmellData, and Atlas::Objects::Operation::FeelData.

virtual void Atlas::Objects::Operation::PerceptionData::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::Operation::InfoData.

Reimplemented in Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::SmellData, and Atlas::Objects::Operation::FeelData.

virtual PerceptionData* Atlas::Objects::Operation::PerceptionData::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::Operation::InfoData.

Reimplemented in Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::SmellData, and Atlas::Objects::Operation::FeelData.

static PerceptionData* Atlas::Objects::Operation::PerceptionData::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::Operation::InfoData.

Reimplemented in Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::SmellData, and Atlas::Objects::Operation::FeelData.

Author

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