Atlas::Objects::Operation::UseData Class Reference

Use a currently wielded tool. More...

#include <Operation.h>

Inheritance diagram for Atlas::Objects::Operation::UseData:

Atlas::Objects::Operation::ActionData Atlas::Objects::Operation::RootOperationData Atlas::Objects::RootData Atlas::Objects::BaseObjectData

List of all members.

Public Member Functions

virtual UseDatacopy () 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 UseDatagetDefaultObject ()
 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 UseDataalloc ()
 Allocate a new instance of this class, using an existing instance if available.
static UseDatagetDefaultObjectInstance ()
 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.

. This is base operation for all other operations and defines basic attributes. You can use this as starting point for browsing whole operation hiearchy. refno refers to operation this is reply for. In examples all attributes that are just as examples (and thus world specific) are started with 'e_'.


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.


The documentation for this class was generated from the following file:

Copyright 2000-2004 the respective authors.

This document can be licensed under the terms of the GNU Free Documentation License or the GNU General Public License and may be freely distributed under the terms given by one of these licenses.