torc::common::Annotated Class Reference
Concept for any object that can be annotated. More...
#include <Annotated.hpp>
Inheritance diagram for torc::common::Annotated:
Public Types | |
| enum | EAnnotationType { ePlacerInstanceTypeIndex, ePlacerInstanceSitePtr, ePlacerInstanceCollection, eRouterNetTilewireSources, eRouterNetTilewireSinks, eRouterNetArcList, eRouterNetRouteNodePtrVector, eRouterNetRouteTime, eRouterNetArcVector, eAnnotationGlobalRouter, eAnnotationCount } |
| Enumeration for all types of annotations. More... | |
Public Member Functions | |
| Annotated () | |
| Default constructor containing no annotations. | |
| ~Annotated () | |
| Destructor. | |
| boost::any | getAnnotation (uint32 inKey) |
| Get an annotation. Returns an empty annotation if the index doesn't exist. | |
| void | setAnnotation (uint32 inKey, boost::any inValue) |
| Set an annotation. | |
| void | removeAnnotation (uint32 inKey) |
| Remove an annotation. | |
| bool | hasAnnotation (uint32 inKey) |
| Check if an annotation exists. | |
Protected Attributes | |
| boost::unordered_map < boost::uint32_t, boost::any > | mAnnotations |
| Map containing any annotations. | |
Private Types | |
| typedef boost::uint32_t | uint32 |
Detailed Description
Concept for any object that can be annotated.Definition at line 29 of file Annotated.hpp.
Member Enumeration Documentation
Constructor & Destructor Documentation
| torc::common::Annotated::Annotated | ( | ) | [inline] |
| torc::common::Annotated::~Annotated | ( | ) | [inline] |
Member Function Documentation
| boost::any torc::common::Annotated::getAnnotation | ( | uint32 | inKey | ) | [inline] |
Get an annotation. Returns an empty annotation if the index doesn't exist.
Definition at line 45 of file Annotated.hpp.
| void torc::common::Annotated::setAnnotation | ( | uint32 | inKey, | |
| boost::any | inValue | |||
| ) | [inline] |
| void torc::common::Annotated::removeAnnotation | ( | uint32 | inKey | ) | [inline] |
| bool torc::common::Annotated::hasAnnotation | ( | uint32 | inKey | ) | [inline] |
Member Data Documentation
boost::unordered_map<boost::uint32_t, boost::any> torc::common::Annotated::mAnnotations [protected] |
The documentation for this class was generated from the following file:
- torc/common/Annotated.hpp
