Atlas_Objects_Operation_InfoData (3) - Linux Manuals

Atlas_Objects_Operation_InfoData: This is base operator for operations that tell you info about objects or events.

NAME

Atlas::Objects::Operation::InfoData - This is base operator for operations that tell you info about objects or events.

SYNOPSIS

#include <Operation.h>

Inherits Atlas::Objects::Operation::RootOperationData.

Inherited by Atlas::Objects::Operation::ErrorData, and Atlas::Objects::Operation::PerceptionData.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

This is base operator for operations that tell you info about objects or events.

Member Function Documentation

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

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

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

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

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

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

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

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

Author

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