Registry which assigns unique integer indices to strings. More...
#include <OpenMS/METADATA/MetaInfoRegistry.h>
| Public Member Functions | |
| MetaInfoRegistry () | |
| default constructor  More... | |
| MetaInfoRegistry (const MetaInfoRegistry &rhs) | |
| copy constructor  More... | |
| ~MetaInfoRegistry () | |
| destructor  More... | |
| MetaInfoRegistry & | operator= (const MetaInfoRegistry &rhs) | 
| assignment operator  More... | |
| UInt | registerName (const String &name, const String &description, const String &unit="") const | 
| void | setDescription (UInt index, const String &description) | 
| Sets the description (String), corresponding to an index.  More... | |
| void | setDescription (const String &name, const String &description) | 
| Sets the description (String), corresponding to a name.  More... | |
| void | setUnit (UInt index, const String &unit) | 
| Sets the unit (String), corresponding to an index.  More... | |
| void | setUnit (const String &name, const String &unit) | 
| Sets the unit (String), corresponding to a name.  More... | |
| UInt | getIndex (const String &name) const | 
| String | getName (UInt index) const | 
| Returns the corresponding name to an index.  More... | |
| String | getDescription (UInt index) const | 
| returns the description of an index  More... | |
| String | getDescription (const String &name) const | 
| returns the description of a name  More... | |
| String | getUnit (UInt index) const | 
| returns the unit of an index  More... | |
| String | getUnit (const String &name) const | 
| returns the unit of a name  More... | |
| Private Attributes | |
| UInt | next_index_ | 
| internal counter, that stores the next index to assign  More... | |
| std::map< String, UInt > | name_to_index_ | 
| map from name to index  More... | |
| std::map< UInt, String > | index_to_name_ | 
| map from index to name  More... | |
| std::map< UInt, String > | index_to_description_ | 
| map from index to description  More... | |
| std::map< UInt, String > | index_to_unit_ | 
| map from index to unit  More... | |
Registry which assigns unique integer indices to strings.
When registering a new name an index >= 1024 is assigned. Indices from 1 to 1023 are reserved for fast access and will never change:
 1 - isotopic_range
 2 - cluster_id
 3 - label
 4 - icon
 5 - color
 6 - RT
 7 - MZ
 8 - predicted_RT
 9 - predicted_RT_p_value
 10 - spectrum_reference
 11 - ID
 12 - low_quality
 13 - charge
 
| MetaInfoRegistry | ( | ) | 
default constructor
| MetaInfoRegistry | ( | const MetaInfoRegistry & | rhs | ) | 
copy constructor
| ~MetaInfoRegistry | ( | ) | 
destructor
returns the description of an index
| Exception::InvalidValue | is thrown for unregistered indices | 
returns the description of a name
| Exception::InvalidValue | is thrown for unregistered names | 
Returns the corresponding integer to a string. If the string is not registered yet, it registers the string (with empty description and empty unit) and returns the corresponding index.
Returns the corresponding name to an index.
| Exception::InvalidValue | is thrown for unregistered indices | 
returns the unit of an index
| Exception::InvalidValue | is thrown for unregistered indices | 
returns the unit of a name
| Exception::InvalidValue | is thrown for unregistered names | 
| MetaInfoRegistry& operator= | ( | const MetaInfoRegistry & | rhs | ) | 
assignment operator
| UInt registerName | ( | const String & | name, | 
| const String & | description, | ||
| const String & | unit = "" | ||
| ) | const | 
Registers a string, stores its description and unit, and returns the corresponding index. If the string is already registered, it returns the index of the string.
Sets the description (String), corresponding to an index.
| Exception::InvalidValue | is thrown for unregistered indices | 
Sets the description (String), corresponding to a name.
| Exception::InvalidValue | is thrown for unregistered names | 
Sets the unit (String), corresponding to an index.
| Exception::InvalidValue | is thrown for unregistered indices | 
Sets the unit (String), corresponding to a name.
| Exception::InvalidValue | is thrown for unregistered names | 
| 
 | mutableprivate | 
internal counter, that stores the next index to assign
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |