XrdCl::PropertyList Class Reference

A key-value pair map storing both keys and values as strings. More...

#include <XrdClPropertyList.hh>

Collaboration diagram for XrdCl::PropertyList:

Public Types
typedef std::map< std::string, std::string >	PropertyMap

Public Member Functions
PropertyMap::const_iterator	begin () const
	Get the begin iterator.
void	Clear ()
	Clear the property list.
PropertyMap::const_iterator	end () const
	Get the end iterator.
template<typename Item >
Item	Get (const std::string &name) const
template<>
XRootDStatus	Get (const std::string &name) const
template<typename Item >
bool	Get (const std::string &name, Item &item) const
template<typename Item >
Item	Get (const std::string &name, uint32_t index) const
template<typename Item >
bool	Get (const std::string &name, uint32_t index, Item &item) const
template<>
bool	Get (const std::string &name, URL &item) const
template<>
bool	Get (const std::string &name, XRootDStatus &item) 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.
template<typename Item >
void	Set (const std::string &name, const Item &value)
template<>
void	Set (const std::string &name, const URL &item)
template<>
void	Set (const std::string &name, const XRootDStatus &item)
template<typename Item >
void	Set (const std::string &name, uint32_t index, const Item &value)

Detailed Description

A key-value pair map storing both keys and values as strings.

Definition at line 40 of file XrdClPropertyList.hh.

Member Typedef Documentation

PropertyMap

typedef std::map<std::string, std::string> XrdCl::PropertyList::PropertyMap

Definition at line 43 of file XrdClPropertyList.hh.

Member Function Documentation

begin()

PropertyMap::const_iterator XrdCl::PropertyList::begin ( ) const

inline

Get the begin iterator.

Definition at line 160 of file XrdClPropertyList.hh.

      {
        return pProperties.begin();
      }

Referenced by XrdCl::CopyProcess::AddJob(), and XrdCl::Utils::LogPropertyList().

Here is the caller graph for this function:

Clear()

void XrdCl::PropertyList::Clear ( )

inline

Clear the property list.

Definition at line 176 of file XrdClPropertyList.hh.

      {
        pProperties.clear();
      }

end()

PropertyMap::const_iterator XrdCl::PropertyList::end ( ) const

inline

Get the end iterator.

Definition at line 168 of file XrdClPropertyList.hh.

      {
        return pProperties.end();
      }

Referenced by XrdCl::CopyProcess::AddJob(), and XrdCl::Utils::LogPropertyList().

Here is the caller graph for this function:

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

Definition at line 84 of file XrdClPropertyList.hh.

      {
        PropertyMap::const_iterator it;
        it = pProperties.find( name );
        if( it == pProperties.end() )
          return Item();
        std::istringstream i; i.str( it->second );
        Item item;
        i >> item;
        if( i.bad() )
          return Item();
        return item;
      }

Get() [2/7]

template<>

XRootDStatus XrdCl::PropertyList::Get ( const std::string &  name ) const

inline

Definition at line 249 of file XrdClPropertyList.hh.

  {
    XRootDStatus st;
    if( !Get( name, st ) )
      return XRootDStatus();
    return st;
  }

References Get().

Here is the call graph for this function:

Get() [3/7]

template<typename Item >

bool XrdCl::PropertyList::Get ( const std::string &  name, Item &  item  ) const

inline

Get the value associated with a name

Returns

true if the name was found, false otherwise

Definition at line 65 of file XrdClPropertyList.hh.

      {
        PropertyMap::const_iterator it;
        it = pProperties.find( name );
        if( it == pProperties.end() )
          return false;
        std::istringstream i; i.str( it->second );
        i >> item;
        if( i.bad() )
          return false;
        return true;
      }

Referenced by XrdCl::CopyProcess::AddJob(), ProgressDisplay::EndJob(), Get(), Get(), Get(), Get(), XrdCl::CopyJob::Init(), XrdCl::CopyProcess::Prepare(), XrdCl::CopyProcess::Run(), XrdCl::ClassicCopyJob::Run(), and XrdCl::TPFallBackCopyJob::Run().

Here is the caller graph for this function:

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

Definition at line 132 of file XrdClPropertyList.hh.

      {
        std::ostringstream o;
        o << name << " " << index;
        return Get<Item>( o.str() );
      }

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

Definition at line 119 of file XrdClPropertyList.hh.

      {
        std::ostringstream o;
        o << name << " " << index;
        return Get( o.str(), item );
      }

References Get().

Here is the call graph for this function:

Get() [6/7]

template<>

bool XrdCl::PropertyList::Get ( const std::string &  name, URL &  item  ) const

inline

Definition at line 272 of file XrdClPropertyList.hh.

  {
    std::string tmp;
    if( !Get( name, tmp ) )
      return false;
 
    item = tmp;
    return true;
  }

References Get().

Here is the call graph for this function:

Get() [7/7]

template<>

bool XrdCl::PropertyList::Get ( const std::string &  name, XRootDStatus &  item  ) const

inline

Definition at line 227 of file XrdClPropertyList.hh.

  {
    std::string str, msg, tmp;
    if( !Get( name, str ) )
      return false;
 
    std::string::size_type i;
    i = str.find( '#' );
    if( i == std::string::npos )
      return false;
    item.SetErrorMessage( str.substr( i+1, str.length()-i-1 ) );
    str.erase( i, str.length()-i );
    std::replace( str.begin(), str.end(), ';', ' ' );
    std::istringstream is; is.str( str );
    is >> item.status; if( is.bad() ) return false;
    is >> item.code;   if( is.bad() ) return false;
    is >> item.errNo;  if( is.bad() ) return false;
    return true;
  }

References XrdCl::Status::code, XrdCl::Status::errNo, Get(), XrdCl::XRootDStatus::SetErrorMessage(), and XrdCl::Status::status.

Here is the call graph for this function:

HasProperty() [1/2]

bool XrdCl::PropertyList::HasProperty ( const std::string &  name ) const

inline

Check if we now about the given name.

Definition at line 142 of file XrdClPropertyList.hh.

      {
        return pProperties.find( name ) != pProperties.end();
      }

Referenced by XrdCl::CopyProcess::AddJob(), HasProperty(), XrdCl::CopyProcess::Prepare(), and XrdCl::CopyProcess::Run().

Here is the caller graph for this function:

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.

Definition at line 150 of file XrdClPropertyList.hh.

      {
        std::ostringstream o;
        o << name << " " << index;
        return HasProperty( o.str() );
      }

References HasProperty().

Here is the call graph for this function:

Set() [1/4]

template<typename Item >

void XrdCl::PropertyList::Set ( const std::string &  name, const Item &  value  )

inline

Associate a value with a key

Parameters

name	must not contain spaces
value	needs to be convertible to std::string

Definition at line 52 of file XrdClPropertyList.hh.

      {
        std::ostringstream o;
        o << value;
        pProperties[name] = o.str();
      }

Referenced by XrdCl::CopyProcess::AddJob(), main(), XrdCl::CopyProcess::Prepare(), XrdCl::ClassicCopyJob::Run(), XrdCl::ThirdPartyCopyJob::Run(), Set(), Set(), and Set().

Here is the caller graph for this function:

Set() [2/4]

template<>

void XrdCl::PropertyList::Set ( const std::string &  name, const URL &  item  )

inline

Definition at line 262 of file XrdClPropertyList.hh.

  {
    Set( name, item.GetURL() );
  }

References XrdCl::URL::GetURL(), and Set().

Here is the call graph for this function:

Set() [3/4]

template<>

void XrdCl::PropertyList::Set ( const std::string &  name, const XRootDStatus &  item  )

inline

Definition at line 214 of file XrdClPropertyList.hh.

  {
    std::ostringstream o;
    o << item.status << ";" << item.code << ";" << item.errNo << "#";
    o << item.GetErrorMessage();
    Set( name, o.str() );
  }

References XrdCl::Status::code, XrdCl::Status::errNo, XrdCl::XRootDStatus::GetErrorMessage(), Set(), and XrdCl::Status::status.

Here is the call graph for this function:

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

Definition at line 106 of file XrdClPropertyList.hh.

      {
        std::ostringstream o;
        o << name << " " << index;
        Set( o.str(), value );
      }

References Set().

Here is the call graph for this function:

---

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

• XrdClPropertyList.hh