A key-value pair map storing both keys and values as strings.
More...
#include <XrdClPropertyList.hh>
|
typedef std::map< std::string, std::string > | PropertyMap |
|
|
template<typename Item > |
void | Set (const std::string &name, const Item &value) |
|
template<typename Item > |
bool | Get (const std::string &name, Item &item) const |
|
template<typename Item > |
Item | Get (const std::string &name) const |
|
template<typename Item > |
void | Set (const std::string &name, uint32_t index, const Item &value) |
|
template<typename Item > |
bool | Get (const std::string &name, uint32_t index, Item &item) const |
|
template<typename Item > |
Item | Get (const std::string &name, uint32_t index) const |
|
bool | HasProperty (const std::string &name) const |
| Check if we now about the given name.
|
|
bool | HasProperty (const std::string &name, uint32_t index) const |
| Check if we know about the given name and index.
|
|
PropertyMap::const_iterator | begin () const |
| Get the begin iterator.
|
|
PropertyMap::const_iterator | end () const |
| Get the end iterator.
|
|
void | Clear () |
| Clear the property list.
|
|
template<> |
void | Set (const std::string &name, const XRootDStatus &item) |
|
template<> |
bool | Get (const std::string &name, XRootDStatus &item) const |
|
template<> |
XRootDStatus | Get (const std::string &name) const |
|
template<> |
void | Set (const std::string &name, const URL &item) |
|
template<> |
bool | Get (const std::string &name, URL &item) const |
|
A key-value pair map storing both keys and values as strings.
◆ PropertyMap
◆ begin()
PropertyMap::const_iterator XrdCl::PropertyList::begin |
( |
| ) |
const |
|
inline |
◆ Clear()
void XrdCl::PropertyList::Clear |
( |
| ) |
|
|
inline |
◆ end()
PropertyMap::const_iterator XrdCl::PropertyList::end |
( |
| ) |
const |
|
inline |
◆ Get() [1/7]
template<typename Item >
Item XrdCl::PropertyList::Get |
( |
const std::string & |
name | ) |
const |
|
inline |
Get the value associated with a name
- Returns
- the value or Item() if the key does not exist
References pProperties.
◆ Get() [2/7]
template<>
XRootDStatus XrdCl::PropertyList::Get |
( |
const std::string & |
name | ) |
const |
|
inline |
◆ Get() [3/7]
template<typename Item >
bool XrdCl::PropertyList::Get |
( |
const std::string & |
name, |
|
|
Item & |
item |
|
) |
| const |
|
inline |
◆ Get() [4/7]
template<typename Item >
Item XrdCl::PropertyList::Get |
( |
const std::string & |
name, |
|
|
uint32_t |
index |
|
) |
| const |
|
inline |
Get the value associated with a key and an index
- Returns
- the value or Item() if the key does not exist
◆ Get() [5/7]
template<typename Item >
bool XrdCl::PropertyList::Get |
( |
const std::string & |
name, |
|
|
uint32_t |
index, |
|
|
Item & |
item |
|
) |
| const |
|
inline |
Get the value associated with a key and an index
- Returns
- true if the key and index were found, false otherwise
References Get().
◆ Get() [6/7]
template<>
bool XrdCl::PropertyList::Get |
( |
const std::string & |
name, |
|
|
URL & |
item |
|
) |
| const |
|
inline |
◆ Get() [7/7]
template<>
bool XrdCl::PropertyList::Get |
( |
const std::string & |
name, |
|
|
XRootDStatus & |
item |
|
) |
| const |
|
inline |
◆ HasProperty() [1/2]
bool XrdCl::PropertyList::HasProperty |
( |
const std::string & |
name | ) |
const |
|
inline |
◆ HasProperty() [2/2]
bool XrdCl::PropertyList::HasProperty |
( |
const std::string & |
name, |
|
|
uint32_t |
index |
|
) |
| const |
|
inline |
Check if we know about the given name and index.
References HasProperty().
◆ Set() [1/4]
template<typename Item >
void XrdCl::PropertyList::Set |
( |
const std::string & |
name, |
|
|
const Item & |
value |
|
) |
| |
|
inline |
◆ Set() [2/4]
template<>
void XrdCl::PropertyList::Set |
( |
const std::string & |
name, |
|
|
const URL & |
item |
|
) |
| |
|
inline |
◆ Set() [3/4]
template<>
void XrdCl::PropertyList::Set |
( |
const std::string & |
name, |
|
|
const XRootDStatus & |
item |
|
) |
| |
|
inline |
◆ Set() [4/4]
template<typename Item >
void XrdCl::PropertyList::Set |
( |
const std::string & |
name, |
|
|
uint32_t |
index, |
|
|
const Item & |
value |
|
) |
| |
|
inline |
Set a value with a name and an index
- Parameters
-
name | must not contain spaces |
index | |
value | must be convertible to std::string |
References Set().
◆ pProperties
The documentation for this class was generated from the following file: