NAME

Atlas::Objects::Operation::ActionData - This is base operator for operations that might have effects.

SYNOPSIS


#include <Operation.h>

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

Inherited by Atlas::Objects::Operation::CreateData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::ImaginaryData, Atlas::Objects::Operation::SetData, and Atlas::Objects::Operation::UseData.

Public Member Functions


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

Protected Member Functions


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

Detailed Description

This is base operator for operations that might have effects.

Member Function Documentation

static ActionData* Atlas::Objects::Operation::ActionData::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::CreateData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::ImaginaryData, and Atlas::Objects::Operation::UseData.

virtual void Atlas::Objects::Operation::ActionData::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::CreateData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::ImaginaryData, and Atlas::Objects::Operation::UseData.

virtual ActionData* Atlas::Objects::Operation::ActionData::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::CreateData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::ImaginaryData, and Atlas::Objects::Operation::UseData.

static ActionData* Atlas::Objects::Operation::ActionData::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::CreateData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::ImaginaryData, and Atlas::Objects::Operation::UseData.

Author

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