NAME

Atlas::Objects::Operation::UseData - Use a currently wielded tool.

SYNOPSIS


#include <Operation.h>

Inherits Atlas::Objects::Operation::ActionData.

Public Member Functions


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

Protected Member Functions


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

Detailed Description

Use a currently wielded tool.

Member Function Documentation

static UseData* Atlas::Objects::Operation::UseData::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::ActionData.

virtual void Atlas::Objects::Operation::UseData::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::ActionData.

virtual UseData* Atlas::Objects::Operation::UseData::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::ActionData.

static UseData* Atlas::Objects::Operation::UseData::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::ActionData.

Author

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