Atlas_Objects_Operation_PerceiveData (3) - Linux Manuals

Atlas_Objects_Operation_PerceiveData: Generic base operation for perceiving things by eyes, ears, etc.

NAME

Atlas::Objects::Operation::PerceiveData - Generic base operation for perceiving things by eyes, ears, etc.

SYNOPSIS

#include <Operation.h>

Inherits Atlas::Objects::Operation::GetData.

Inherited by Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::SniffData, and Atlas::Objects::Operation::TouchData.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Generic base operation for perceiving things by eyes, ears, etc.

Member Function Documentation

static PerceiveData* Atlas::Objects::Operation::PerceiveData::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::GetData.

Reimplemented in Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, and Atlas::Objects::Operation::TouchData.

virtual void Atlas::Objects::Operation::PerceiveData::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::GetData.

Reimplemented in Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, and Atlas::Objects::Operation::TouchData.

virtual PerceiveData* Atlas::Objects::Operation::PerceiveData::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::GetData.

Reimplemented in Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, and Atlas::Objects::Operation::TouchData.

static PerceiveData* Atlas::Objects::Operation::PerceiveData::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::GetData.

Reimplemented in Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, and Atlas::Objects::Operation::TouchData.

Author

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