A collection of attributes.
More...
#include <mia/core/attributes.hh>
A collection of attributes.
This is the base class for all data that uses attributes. It provides all the needed functions to store and retrive attributes.
Definition at line 252 of file attributes.hh.
CAttributedData::CAttributedData |
( |
| ) |
|
Constructor that initialises with a certain attribute map
- Parameters
-
attr | the map to be initialised with |
CAttributeMap::const_iterator CAttributedData::begin_attributes |
( |
| ) |
const |
- Returns
- the begin iterator to the attributes
void CAttributedData::delete_attribute |
( |
const std::string & |
key | ) |
|
Delete the attribute with a given key from the list
- Parameters
-
CAttributeMap::const_iterator CAttributedData::end_attributes |
( |
| ) |
const |
- Returns
- the end iterator to the attributes
const PAttribute CAttributedData::get_attribute |
( |
const std::string & |
key | ) |
const |
- Parameters
-
- Returns
- the attribute with name name or NULL (wrapped as shared pointer) if the attribute with name is not found
Referenced by get_attribute_as().
template<typename T >
const T CAttributedData::get_attribute_as |
( |
const std::string & |
key | ) |
const |
Look for a certain attribute and try to cast it to the output type. If the attribute is not found, a std::invalid_argument exception is thrown. If the cast fails then std::bad_cast exception will be thrown.
- Parameters
-
key | the key of the attribute to look up. |
- Returns
- the value of the attribute
Definition at line 743 of file attributes.hh.
References get_attribute().
template<typename T >
const T CAttributedData::get_attribute_as |
( |
const std::string & |
key, |
|
|
T |
default_value |
|
) |
| const |
Look for a certain attribute and try to cast it to the output type. If the attribute is not found, or the cast goes wrong use the default value In the latter case a warning is written out.
- Parameters
-
key | the key of the attribute to look up. |
default_value | the default value |
- Returns
- the value of the attribute
Definition at line 753 of file attributes.hh.
References cvwarn(), and get_attribute().
const std::string CAttributedData::get_attribute_as_string |
( |
const std::string & |
key | ) |
const |
returns the requested attribute as string, returns an empty string if attribute doesn't exist
bool CAttributedData::has_attribute |
( |
const std::string & |
key | ) |
const |
See if a certain attribute exists
- Parameters
-
- Returns
- true if attribute exists, false otherwise
void CAttributedData::print |
( |
std::ostream & |
os | ) |
const |
|
inline |
void CAttributedData::set_attribute |
( |
const std::string & |
key, |
|
|
PAttribute |
attr |
|
) |
| |
Sets the attribute name to value attr. If attr is NULL, then the attribute is removed from the list (or not added)
- Parameters
-
void CAttributedData::set_attribute |
( |
const std::string & |
key, |
|
|
const std::string & |
value |
|
) |
| |
Set an attribute using one of the defined translators
- Parameters
-
template<typename T >
void CAttributedData::set_attribute |
( |
const std::string & |
key, |
|
|
const T & |
value |
|
) |
| |
Set an attribute, generic version.
- Template Parameters
-
T | type of the attribute value to be set |
- Parameters
-
Definition at line 690 of file attributes.hh.
References add_attribute().
void CAttributedData::set_attribute |
( |
const std::string & |
key, |
|
|
const char * |
value |
|
) |
| |
Set an attribute using one of the defined translators
- Parameters
-
void CAttributedData::set_attributes |
( |
CAttributeMap::const_iterator |
begin, |
|
|
CAttributeMap::const_iterator |
end |
|
) |
| |
Insersts or overwrites the attributes given in the input range
- Parameters
-
The documentation for this class was generated from the following file: