MVNest Class Reference
Class for a nest. More...
#include <MVNest.h>
Inheritance diagram for MVNest:
Public Member Functions | |
| MVNest () | |
| Default constructor. | |
| void | addToComponents (MVOnPlaceObject *object) |
| Adds an OnPlaceObject to the nest's components. | |
| void | removeFromComponents (MVOnPlaceObject *object) |
| Removes an OnPlaceObject from the nest's components. | |
| std::vector< MVOnPlaceObject * > * | getComponents () |
| Returns a pointer to the list of objects in the nest's components. | |
| virtual string | toString () const |
| Returns a textual representation. | |
| virtual string | className () const |
| Returns the class name of the object. | |
| virtual enum classId | classId () const |
| Returns the class id of the object. | |
Private Attributes | |
| std::vector< MVOnPlaceObject * > | components |
| Vector of components the nest is build of. | |
Detailed Description
Class for a nest.This class represents a nest on a place.
Constructor & Destructor Documentation
| MVNest::MVNest | ( | ) |
Default constructor.
Member Function Documentation
| void MVNest::addToComponents | ( | MVOnPlaceObject * | object | ) |
Adds an OnPlaceObject to the nest's components.
Adds an OnPlaceObject to the nest's components.
- Parameters:
-
object Pointer to the object, instance of MVOnPlaceObject, which should be added.
| void MVNest::removeFromComponents | ( | MVOnPlaceObject * | object | ) |
Removes an OnPlaceObject from the nest's components.
Removes an OnPlaceObject from the nest's components.
- Parameters:
-
object Pointer to the object, instance of MVOnPlaceObject, which should be removed.
| std::vector< MVOnPlaceObject * > * MVNest::getComponents | ( | ) |
Returns a pointer to the list of objects in the nest's components.
Returns a pointer to the list of objects in the nest's components.
| string MVNest::toString | ( | ) | const [virtual] |
Returns a textual representation.
- Returns:
- a string descriping the run-time object
Reimplemented from MVOnPlaceObject.
| string MVNest::className | ( | ) | const [virtual] |
Returns the class name of the object.
- Returns:
- a string with the name of the object's class
Reimplemented from MVOnPlaceObject.
| enum classId MVNest::classId | ( | ) | const [virtual] |
Returns the class id of the object.
- Returns:
- an id of the object's class
Reimplemented from MVOnPlaceObject.
Member Data Documentation
std::vector<MVOnPlaceObject *> MVNest::components [private] |
Vector of components the nest is build of.
The documentation for this class was generated from the following files:
