XMLStorage::const_XMLPos Struct Reference

iterator for XML trees More...

#include <xmlstorage.h>

Collaboration diagram for XMLStorage::const_XMLPos:

Public Member Functions
	const_XMLPos (const XMLNode *root)
	const_XMLPos (const const_XMLPos &other)
	const_XMLPos (const XMLPos &other)
const XMLNode &	cur () const
	access to current node
	operator const XMLNode * () const
	automatic access to current node
const XMLNode *	operator-> () const
const XMLNode &	operator* () const
XS_String	get (const XS_String &attr_name) const
	attribute access
template<typename T >
XS_String	get (const T &attr_name) const
	index operator attribute access
XS_String	operator[] (const XS_String &attr_name) const
bool	back ()
	go back to previous position
bool	go_down ()
	go down to first child
bool	go_down (const XS_String &child_name, int n=0)
	search for child and go down
bool	iterate (const XS_String &child_name, size_t &cnt)
	iterate to the next matching child
bool	go (const XPath &xpath)
	move to the position defined by xpath in XML tree
const XS_String &	str () const

Protected Member Functions
void	go_to (const XMLNode *child)
	go to specified node

Protected Attributes
const XMLNode *	_root
const XMLNode *	_cur
std::stack< const XMLNode * >	_stack

Detailed Description

iterator for XML trees

Definition at line 1795 of file xmlstorage.h.

Constructor & Destructor Documentation

const_XMLPos() [1/3]

XMLStorage::const_XMLPos::const_XMLPos ( const XMLNode *  root )

inline

Definition at line 1797 of file xmlstorage.h.

     :  _root(root),
        _cur(root)
    {
    }

const_XMLPos() [2/3]

XMLStorage::const_XMLPos::const_XMLPos ( const const_XMLPos &  other )

inline

Definition at line 1803 of file xmlstorage.h.

     :  _root(other._root),
        _cur(other._cur)
    {   // don't copy _stack
    }

const_XMLPos() [3/3]

XMLStorage::const_XMLPos::const_XMLPos ( const XMLPos &  other )

inline

Definition at line 1809 of file xmlstorage.h.

     :  _root(other._root),
        _cur(other._cur)
    {   // don't copy _stack
    }

Member Function Documentation

back()

bool XMLStorage::const_XMLPos::back ( )

inline

go back to previous position

Definition at line 1839 of file xmlstorage.h.

    {
        if (!_stack.empty()) {
            _cur = _stack.top();
            _stack.pop();
            return true;
        } else
            return false;
    }

cur()

const XMLNode & XMLStorage::const_XMLPos::cur ( ) const

inline

access to current node

Definition at line 1816 of file xmlstorage.h.

    {
        return *_cur;
    }

get() [1/2]

template<typename T >

XS_String XMLStorage::const_XMLPos::get ( const T &  attr_name ) const

inline

index operator attribute access

Definition at line 1835 of file xmlstorage.h.

{return _cur->get(attr_name);}

get() [2/2]

XS_String XMLStorage::const_XMLPos::get ( const XS_String &  attr_name ) const

inline

attribute access

Definition at line 1829 of file xmlstorage.h.

    {
        return _cur->get(attr_name);
    }

Referenced by XMLStorage::read_option().

go()

bool XMLStorage::const_XMLPos::go

(

const XPath &

xpath

)

move to the position defined by xpath in XML tree

Definition at line 128 of file xmlstorage.cpp.

{
    const XMLNode* node = xpath._absolute? _root: _cur;
 
    node = node->find_relative(xpath);
 
    if (node) {
        go_to(node);
        return true;
    } else
        return false;
}

go_down() [1/2]

bool XMLStorage::const_XMLPos::go_down ( )

inline

go down to first child

Definition at line 1850 of file xmlstorage.h.

    {
        const XMLNode* node = _cur->get_first_child();
 
        if (node) {
            go_to(node);
            return true;
        } else
            return false;
    }

go_down() [2/2]

bool XMLStorage::const_XMLPos::go_down ( const XS_String &  child_name, int  n = 0  )

inline

search for child and go down

Definition at line 1862 of file xmlstorage.h.

    {
        const XMLNode* node = XPathElement(child_name, n).const_find(_cur);
 
        if (node) {
            go_to(node);
            return true;
        } else
            return false;
    }

go_to()

void XMLStorage::const_XMLPos::go_to ( const XMLNode *  child )

inlineprotected

go to specified node

Definition at line 1911 of file xmlstorage.h.

    {
        _stack.push(_cur);
        _cur = child;
    }

Referenced by go(), go_down(), and iterate().

iterate()

bool XMLStorage::const_XMLPos::iterate ( const XS_String &  child_name, size_t &  cnt  )

inline

iterate to the next matching child

Definition at line 1874 of file xmlstorage.h.

    {
        const XMLNode* node = XPathElement(child_name, cnt).const_find(_cur);
 
        if (node) {
            go_to(node);
            ++cnt;
            return true;
        } else
            return false;
    }

operator const XMLNode *()

XMLStorage::const_XMLPos::operator const XMLNode * ( ) const

inline

automatic access to current node

Definition at line 1822 of file xmlstorage.h.

{return _cur;}

operator*()

const XMLNode & XMLStorage::const_XMLPos::operator* ( ) const

inline

Definition at line 1826 of file xmlstorage.h.

{return *_cur;}

operator->()

const XMLNode * XMLStorage::const_XMLPos::operator-> ( ) const

inline

Definition at line 1824 of file xmlstorage.h.

{return _cur;}

operator[]()

XS_String XMLStorage::const_XMLPos::operator[] ( const XS_String &  attr_name ) const

inline

Definition at line 1836 of file xmlstorage.h.

{return _cur->get(attr_name);}

str()

const XS_String & XMLStorage::const_XMLPos::str ( ) const

inline

Definition at line 1903 of file xmlstorage.h.

{return *_cur;}

Member Data Documentation

_cur

const XMLNode* XMLStorage::const_XMLPos::_cur

protected

Definition at line 1907 of file xmlstorage.h.

Referenced by back(), cur(), get(), go(), go_down(), go_to(), iterate(), operator const XMLNode *(), operator*(), operator->(), operator[](), and str().

_root

const XMLNode* XMLStorage::const_XMLPos::_root

protected

Definition at line 1906 of file xmlstorage.h.

Referenced by go().

_stack

std::stack<const XMLNode*> XMLStorage::const_XMLPos::_stack

protected

Definition at line 1908 of file xmlstorage.h.

Referenced by back(), and go_to().

---

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

• modules/rosapps/applications/explorer-old/utility/xmlstorage.h
• modules/rosapps/applications/explorer-old/utility/xmlstorage.cpp