Atlas_Objects_Operation_TouchData (3) - Linux Manuals

Atlas_Objects_Operation_TouchData: Touch something.

NAME

Atlas::Objects::Operation::TouchData - Touch something.

SYNOPSIS

#include <Operation.h>

Inherits Atlas::Objects::Operation::PerceiveData.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Touch something.

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

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

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

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

Author

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