The class is responsible for holding and providing access to objects of type TaggedObject. More...
#include <MapOfTaggedObjects.h>
Public Member Functions | |
| MapOfTaggedObjects (CommandEntity *owr, const std::string &containerName) | |
| Creates the map object and an iter for iterating through the objects that are added to the map. More... | |
| MapOfTaggedObjects (const MapOfTaggedObjects &) | |
| Copy constructor. | |
| MapOfTaggedObjects & | operator= (const MapOfTaggedObjects &) |
| Assignment operator. | |
| const_iterator | begin (void) const |
| const_iterator | end (void) const |
| int | setSize (int newSize) |
| Set the container size. More... | |
| bool | addComponent (TaggedObject *newComponent) |
| Adds a component to the container. More... | |
| bool | removeComponent (int tag) |
| Adds a component to the container. More... | |
| int | getNumComponents (void) const |
| Returns the number of components currently stored in the container. More... | |
| TaggedObject * | getComponentPtr (int tag) |
To return a pointer to the TaggedObject whose identifier is given by tag. More... | |
| const TaggedObject * | getComponentPtr (int tag) const |
To return a pointer to the TaggedObject whose identifier is given by tag. More... | |
| TaggedObjectIter & | getComponents () |
| MapOfTaggedObjectsIter | getIter () |
| To return an iter for iterating through the objects that have been added to the container. More... | |
| TaggedObjectStorage * | getEmptyCopy (void) |
| Get an empty copy of the method. More... | |
| void | clearAll (bool invokeDestructor=true) |
| Remove all objects from the container. More... | |
| void | Print (std::ostream &s, int flag=0) const |
| Print stuff. | |
Protected Member Functions | |
| iterator | begin (void) |
| iterator | end (void) |
| void | clearComponents (void) |
| Free memory reserved for components. | |
Friends | |
| class | MapOfTaggedObjectsIter |
Detailed Description
The class is responsible for holding and providing access to objects of type TaggedObject.
A map template of the standard template class is used to store the pointers to these objects.
A MapOfTaggedObjects object is used as a container to store and provide access to objects of type TaggedObject. A MapOfTaggedObjects creates a map object to store the pointers to these objects. A map is created using a template provided by the standard template library. The key used to identify the pointers stored in the map object is the TaggedObjects tag. Each MapOfTaggedObject object also contains a MapOfTaggedObjectsIter object to iterate through the objects which have been added.
Constructor & Destructor Documentation
◆ MapOfTaggedObjects()
| XC::MapOfTaggedObjects::MapOfTaggedObjects | ( | CommandEntity * | owr, |
| const std::string & | containerName | ||
| ) |
Creates the map object and an iter for iterating through the objects that are added to the map.
- Parameters
-
owr object owner (this object is somewhat contained by).
Member Function Documentation
◆ addComponent()
| bool XC::MapOfTaggedObjects::addComponent | ( | TaggedObject * | newComponent | ) |
Adds a component to the container.
To add the object newComponent to the container. First checks to see if an element with a similar tag already exists in the map. If not, the pointer to newElement is added to the map using the insert() method. A check is then made to ensure that the object has been added. (This is done as insert() returns no error flag). Returns true if successful. If not successful, a warning is raised and false is returned. Note that the map template does not allow items with duplicate keys to be added.
◆ clearAll()
| void XC::MapOfTaggedObjects::clearAll | ( | bool | invokeDestructor = true | ) |
Remove all objects from the container.
To remove all objects from the container and { to invoke the destructor on these objects}. Goes through the container, invoking the destructor on any object in the map. It then invokes clear() on the map object to clear it.
◆ getComponentPtr() [1/2]
| XC::TaggedObject * XC::MapOfTaggedObjects::getComponentPtr | ( | int | tag | ) |
To return a pointer to the TaggedObject whose identifier is given by tag.
To return a pointer to the TaggedObject whose identifier is given by tag. Invokes {find(tag)} on the map to determine if the component is in the container. If it is a pointer to the component is returned. If it is not in the map \(0\) is returned.
◆ getComponentPtr() [2/2]
| const XC::TaggedObject * XC::MapOfTaggedObjects::getComponentPtr | ( | int | tag | ) | const |
To return a pointer to the TaggedObject whose identifier is given by tag.
Const version of the method.
◆ getEmptyCopy()
| XC::TaggedObjectStorage * XC::MapOfTaggedObjects::getEmptyCopy | ( | void | ) |
Get an empty copy of the method.
Returns a pointer to a new MapOfTaggedObjects which was created using new(). The new container that is returned is an empty container. If not enough memory is available to create this object a warning is raised and \(0\) is returned. Note that it is the responsibility of the caller to invoke the destructor on the object that is returned.
◆ getIter()
| XC::MapOfTaggedObjectsIter XC::MapOfTaggedObjects::getIter | ( | void | ) |
To return an iter for iterating through the objects that have been added to the container.
Each MapOfTaggedObjects object has its own iter. This iter() is first reset and a reference to this iter is then returned.
◆ getNumComponents()
| int XC::MapOfTaggedObjects::getNumComponents | ( | void | ) | const |
Returns the number of components currently stored in the container.
This is found by invoking size() on the map object.
◆ removeComponent()
| bool XC::MapOfTaggedObjects::removeComponent | ( | int | tag | ) |
Adds a component to the container.
To remove the component whose tag is given by tag from the container and return a pointer to the object. Invokes {find(tag)} on the map to first see if the element is there. If it is {erase(tag)} is invoked on the map to remove the item. \(0\) is returned if the component is not in the map, otherwise a pointer to the component is returned.
◆ setSize()
| int XC::MapOfTaggedObjects::setSize | ( | int | newSize | ) |
Set the container size.
Checks to see that max size for the map (which is a built in value defined for the template class) is larger than newSize. Returns \(0\) if successful. If not successful, a warning is raised and \(-1\) is returned.
The documentation for this class was generated from the following files:
- src/utility/tagged/storage/MapOfTaggedObjects.h
- src/utility/tagged/storage/MapOfTaggedObjects.cpp
