irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::children_parser Class Reference

#include <irods_children_parser.hpp>

Collaboration diagram for irods::children_parser:
[legend]

Public Types

typedef std::map< std::string, std::string > children_map_t
 
typedef children_map_t::const_iterator const_iterator
 

Public Member Functions

 children_parser (void)
 
virtual ~children_parser (void)
 
error list (children_map_t &list)
 
error str (std::string &ret_string) const
 
error add_child (const std::string &child, const std::string &context)
 
error remove_child (const std::string &child)
 
error set_string (const std::string &str)
 
error first_child (std::string &_child)
 
error last_child (std::string &_child)
 
const_iterator begin (void) const
 
const_iterator end (void) const
 

Private Attributes

children_map_t children_list_
 

Detailed Description

Description:\n Class for managing the children string of a resource

Definition at line 15 of file irods_children_parser.hpp.

Member Typedef Documentation

◆ children_map_t

typedef std::map<std::string, std::string> irods::children_parser::children_map_t

Definition at line 17 of file irods_children_parser.hpp.

◆ const_iterator

typedef children_map_t::const_iterator irods::children_parser::const_iterator

Definition at line 18 of file irods_children_parser.hpp.

Constructor & Destructor Documentation

◆ children_parser()

irods::children_parser::children_parser ( void  )
Description:\n Constructor

Definition at line 10 of file irods_children_parser.cpp.

◆ ~children_parser()

irods::children_parser::~children_parser ( void  )
virtual

Definition at line 13 of file irods_children_parser.cpp.

Member Function Documentation

◆ add_child()

error irods::children_parser::add_child ( const std::string &  child,
const std::string &  context 
)
Description:\n Adds the specified child and context string to the children list

Definition at line 41 of file irods_children_parser.cpp.

References CHILD_EXISTS, children_list_, ERROR, and SUCCESS.

◆ begin()

children_parser::const_iterator irods::children_parser::begin ( void  ) const
Description:\n Returns an iterator to the beginning of the list

Definition at line 167 of file irods_children_parser.cpp.

References children_list_.

◆ end()

children_parser::const_iterator irods::children_parser::end ( void  ) const
Description:\n Returns an iterator to the end of the list

Definition at line 171 of file irods_children_parser.cpp.

References children_list_.

◆ first_child()

error irods::children_parser::first_child ( std::string &  _child)
Description:\n Returns the name of the first child in the list

Definition at line 73 of file irods_children_parser.cpp.

References CHILD_NOT_FOUND, children_list_, ERROR, and SUCCESS.

◆ last_child()

error irods::children_parser::last_child ( std::string &  _child)
Description:\n Returns the name of the last child in the list

Definition at line 90 of file irods_children_parser.cpp.

References CHILD_NOT_FOUND, children_list_, ERROR, and SUCCESS.

◆ list()

error irods::children_parser::list ( children_map_t list)
Description:\n Returns the list of children and context strings

Definition at line 17 of file irods_children_parser.cpp.

References children_list_, and SUCCESS.

Referenced by db_add_child_resc_op().

◆ remove_child()

error irods::children_parser::remove_child ( const std::string &  child)
Description:\n Removes the specified child from the list

Definition at line 57 of file irods_children_parser.cpp.

References CHILD_NOT_FOUND, children_list_, ERROR, and SUCCESS.

◆ set_string()

error irods::children_parser::set_string ( const std::string &  str)
Description:\n Sets the children string to parse

Definition at line 110 of file irods_children_parser.cpp.

References CHILD_NOT_FOUND, children_list_, ERROR, irods::error::ok(), str(), and SUCCESS.

Referenced by db_add_child_resc_op().

Here is the call graph for this function:

◆ str()

error irods::children_parser::str ( std::string &  ret_string) const
Description:\n Returns the encoded children string

Definition at line 23 of file irods_children_parser.cpp.

References children_list_, and SUCCESS.

Referenced by set_string().

Member Data Documentation

◆ children_list_

children_map_t irods::children_parser::children_list_
private

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