| The Gaudi Framework v29r0 (ff2e7097)

- 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 17 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 69 of file Annotation.h.

70 {
71 if ( m_identifiers.find( key ) != m_identifiers.end() ) return false;
72 m_annotationItems.emplace_back( key, value, sticky );
73 m_identifiers.emplace( key, m_annotationItems.size() - 1 );
74 return true;
75 }
std::map::end
T end(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:63
std::map::find
T find(T...args)
std::map::emplace
T emplace(T...args)

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

Individual access to the Annotation-items.

Definition at line 126 of file Annotation.h.

127 {
128 if ( index < 0 || index >= static_cast<int>( m_annotationItems.size() ) ) return emptyString;
129 return m_annotationItems[index].m_key;
130 }
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:65

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

Remove the item indicated by a given key.

Definition at line 77 of file Annotation.h.

78 {
79 auto iKey = m_identifiers.find( key );
80 if ( iKey == m_identifiers.end() ) return false;
81
82 unsigned int indexToBeRemoved = iKey->second;
83 // check stickness
84
85 if ( m_annotationItems[indexToBeRemoved].m_sticky ) return false;
86
87 // why rebuilding ?
88
89 m_identifiers.clear();
90 std::vector<AnnotationItem> annotationItemsNew;
91 if ( m_annotationItems.size() > 1 ) annotationItemsNew.reserve( m_annotationItems.size() - 1 );
92 for ( unsigned int iItem = 0; iItem < m_annotationItems.size(); ++iItem ) {
93 if ( iItem == indexToBeRemoved ) continue;
94 const auto& item = m_annotationItems[iItem];
95 annotationItemsNew.emplace_back( item.m_key, item.m_value, item.m_sticky );
96 m_identifiers.emplace( item.m_key, annotationItemsNew.size() - 1 );
97 }
98 m_annotationItems = std::move( annotationItemsNew );
99 return true;
100 }
std::map::end
T end(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
std::map::clear
T clear(T...args)
std::move
T move(T...args)
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:63
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)
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 138 of file Annotation.h.

139 {
140 // Collect the non-sticky items
141 std::vector<std::string> itemsToRemove;
142 itemsToRemove.reserve( size() );
143 for ( const auto& item : m_annotationItems ) {
144 if ( !item.m_sticky ) itemsToRemove.push_back( item.m_key );
145 }
146 for ( const auto& i : itemsToRemove ) removeItem( i );
147 }
AIDA::Annotation::size
int size() const override
Get the number of items in the Annotation.
Definition: Annotation.h:124
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
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:77
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 118 of file Annotation.h.

119 {
120 auto iKey = m_identifiers.find( key );
121 if ( iKey != m_identifiers.end() ) m_annotationItems[iKey->second].m_sticky = sticky;
122 }
std::map::end
T end(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:63
std::map::find
T find(T...args)

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

Set value for a given key.

Definition at line 108 of file Annotation.h.

109 {
110 auto iKey = m_identifiers.find( key );
111 if ( iKey == m_identifiers.end() )
112 // if not found, then add it
113 addItem( key, value );
114 else
115 m_annotationItems[iKey->second].m_value = value;
116 }
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:69
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:63
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:102

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

Get the number of items in the Annotation.

Definition at line 124 of file Annotation.h.

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

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

Retrieve the value for a given key.

Definition at line 102 of file Annotation.h.

103 {
104 auto iKey = m_identifiers.find( key );
105 return iKey != m_identifiers.end() ? m_annotationItems[iKey->second].m_value : emptyString;
106 }
std::map::end
T end(T...args)
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:65
AIDA::Annotation::m_identifiers
std::map< std::string, unsigned int > m_identifiers
The map of strings to identifiers.
Definition: Annotation.h:63
std::map::find
T find(T...args)

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

Definition at line 132 of file Annotation.h.

133 {
134 if ( index < 0 || index >= static_cast<int>( m_annotationItems.size() ) ) return emptyString;
135 return m_annotationItems[index].m_value;
136 }
AIDA::Annotation::m_annotationItems
std::vector< AnnotationItem > m_annotationItems
The vector of the annotation items.
Definition: Annotation.h:60
AIDA::Annotation::emptyString
std::string emptyString
Definition: Annotation.h:65

## Member Data Documentation

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

Definition at line 65 of file Annotation.h.

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

The vector of the annotation items.

Definition at line 60 of file Annotation.h.

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

The map of strings to identifiers.

Definition at line 63 of file Annotation.h.

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

- GaudiCommonSvc/GaudiCommonSvc/Annotation.h