| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Classes | Public Member Functions | Private Attributes | List of all members
AIDA::Annotation Class Reference

Implementation of the AIDA IAnnotation interface class. More...

`#include <GaudiCommonSvc/Annotation.h>`

Inheritance diagram for AIDA::Annotation:
[legend]
Collaboration diagram for AIDA::Annotation:
[legend]

## Classes
struct | AnnotationItem
| Internal private annotation item class. More...

## Public Member Functions
bool | addItem (const std::string &key, const std::string &value, bool sticky=false) override
| Add a key/value pair with a given sticky. More...
bool | removeItem (const std::string &key) override
| Remove the item indicated by a given key. More...
std::string | value (const std::string &key) const override
| Retrieve the value for a given key. More...
void | setValue (const std::string &key, const std::string &value) override
| Set value for a given key. More...
void | setSticky (const std::string &key, bool sticky) override
| Set sticky for a given key. More...
int | size () const override
| Get the number of items in the Annotation. More...
std::string | key (int index) const override
| Individual access to the Annotation-items. More...
std::string | value (int index) const override
void | reset () override
| Remove all the non-sticky items. More...

## Private Attributes
std::vector< AnnotationItem > | m_annotationItems
| The vector of the annotation items. More...
std::map< std::string, unsigned int > | m_identifiers
| The map of strings to identifiers. More...
std::string | emptyString

## Detailed Description

Implementation of the AIDA IAnnotation interface class.

Definition at line 16 of file Annotation.h.

## Member Function Documentation

bool AIDA::Annotation::addItem | ( | const std::string & | key,
|  | const std::string & | value,
|  | bool | sticky = `false`
| ) |  |
| inline override

Add a key/value pair with a given sticky.

Definition at line 73 of file Annotation.h.

76 {
77 if ( m_identifiers.find( key ) != m_identifiers.end() ) return false;
78 m_annotationItems.emplace_back( key, value, sticky );
79 m_identifiers.emplace( key, m_annotationItems.size() - 1 );
80 return true;
81 }
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:67
std::map::end
T end(T...args)
std::map::find
T find(T...args)
std::map::emplace
T emplace(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

std::string AIDA::Annotation::key | ( | int | index | ) | const
| inline override

Individual access to the Annotation-items.

Definition at line 134 of file Annotation.h.

135 {
136 if ( index < 0 || index >= static_cast<int>(m_annotationItems.size()) ) return emptyString;
137 return m_annotationItems[ index ].m_key;
138 }
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:69
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

bool AIDA::Annotation::removeItem | ( | const std::string & | key | ) |
| inline override

Remove the item indicated by a given key.

Definition at line 83 of file Annotation.h.

83 {
84 auto iKey = m_identifiers.find( key );
85 if ( iKey == m_identifiers.end() ) return false;
86
87 unsigned int indexToBeRemoved = iKey->second;
88 // check stickness
89
90 if ( m_annotationItems[indexToBeRemoved].m_sticky ) return false;
91
92 // why rebuilding ?
93
94 m_identifiers.clear();
95 std::vector< AnnotationItem > annotationItemsNew;
96 if ( m_annotationItems.size() > 1 ) annotationItemsNew.reserve( m_annotationItems.size() - 1 );
97 for ( unsigned int iItem = 0; iItem < m_annotationItems.size(); ++iItem ) {
98 if ( iItem == indexToBeRemoved ) continue;
99 const auto& item = m_annotationItems[ iItem ];
100 annotationItemsNew.emplace_back( item.m_key, item.m_value, item.m_sticky );
101 m_identifiers.emplace( item.m_key, annotationItemsNew.size() - 1 );
102 }
103 m_annotationItems = std::move(annotationItemsNew);
104 return true;
105 }
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:67
std::map::end
T end(T...args)
std::map::clear
T clear(T...args)
std::move
T move(T...args)
std::map::find
T find(T...args)
std::vector::size
T size(T...args)
std::vector
STL class.
std::map::emplace
T emplace(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64
std::vector::reserve
T reserve(T...args)
std::vector::emplace_back
T emplace_back(T...args)

void AIDA::Annotation::reset | ( |  | ) |
| inline override

Remove all the non-sticky items.

Definition at line 146 of file Annotation.h.

147 {
148 // Collect the non-sticky items
149 std::vector< std::string > itemsToRemove;
150 itemsToRemove.reserve( size() );
151 for ( const auto& item : m_annotationItems ) {
152 if ( !item.m_sticky ) itemsToRemove.push_back( item.m_key );
153 }
154 for ( const auto& i : itemsToRemove ) removeItem(i);
155 }
AIDA::Annotation::size
int size() const override
Get the number of items in the Annotation.
Definition: Annotation.h:130
std::vector::push_back
T push_back(T...args)
std::vector< std::string >
AIDA::Annotation::removeItem
bool removeItem(const std::string &key) override
Remove the item indicated by a given key.
Definition: Annotation.h:83
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64
std::vector::reserve
T reserve(T...args)

void AIDA::Annotation::setSticky | ( | const std::string & | key,
|  | bool | sticky
| ) |  |
| inline override

Set sticky for a given key.

Definition at line 124 of file Annotation.h.

125 {
126 auto iKey = m_identifiers.find( key );
127 if ( iKey != m_identifiers.end() ) m_annotationItems[ iKey->second ].m_sticky = sticky;
128 }
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:67
std::map::end
T end(T...args)
std::map::find
T find(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

void AIDA::Annotation::setValue | ( | const std::string & | key,
|  | const std::string & | value
| ) |  |
| inline override

Set value for a given key.

Definition at line 114 of file Annotation.h.

115 {
116 auto iKey = m_identifiers.find( key );
117 if ( iKey == m_identifiers.end() )
118 // if not found, then add it
119 addItem(key,value);
120 else
121 m_annotationItems[ iKey->second ].m_value = value;
122 }
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:67
std::map::end
T end(T...args)
AIDA::Annotation::addItem
bool addItem(const std::string &key, const std::string &value, bool sticky=false) override
Add a key/value pair with a given sticky.
Definition: Annotation.h:73
std::map::find
T find(T...args)
AIDA::Annotation::value
std::string value(const std::string &key) const override
Retrieve the value for a given key.
Definition: Annotation.h:107
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

int AIDA::Annotation::size | ( |  | ) | const
| inline override

Get the number of items in the Annotation.

Definition at line 130 of file Annotation.h.

130 {
131 return m_annotationItems.size();
132 }
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

std::string AIDA::Annotation::value | ( | const std::string & | key | ) | const
| inline override

Retrieve the value for a given key.

Definition at line 107 of file Annotation.h.

108 {
109 auto iKey = m_identifiers.find( key );
110 return iKey != m_identifiers.end() ? m_annotationItems[ iKey->second ].m_value
111 : emptyString;
112 }
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:67
std::map::end
T end(T...args)
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:69
std::map::find
T find(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

std::string AIDA::Annotation::value | ( | int | index | ) | const
| inline override

Definition at line 140 of file Annotation.h.

141 {
142 if ( index < 0 || index >= static_cast<int>(m_annotationItems.size()) ) return emptyString;
143 return m_annotationItems[ index ].m_value;
144 }
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:69
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:64

## Member Data Documentation

std::string AIDA::Annotation::emptyString
| private

Definition at line 69 of file Annotation.h.

std::vector< AnnotationItem > AIDA::Annotation::m_annotationItems
| private

The vector of the annotation items.

Definition at line 64 of file Annotation.h.

std::map< std::string, unsigned int > AIDA::Annotation::m_identifiers
| private

The map of strings to identifiers.

Definition at line 67 of file Annotation.h.

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

- GaudiCommonSvc/GaudiCommonSvc/Annotation.h