belfem::XML Class Reference

XML document interface. More...

#include <cl_XML.hpp>

Public Member Functions
	XML (const string &aPath, const FileMode aMode=FileMode::OPEN_RDONLY)
	~XML ()
const string &	path () const
	return the path of this file
bool	child_exists (const string &aLabel)
	test if at least one child of that name exists
uint	number_of_children ()
	cont the number of children in current tag
uint	number_of_children (const string &aLabel)
	cont the number of children with that name
bool	next_sibling_of_same_name ()
	move to the next sibling of the same name; returns false ( selection unchanged ) if there is none
void	select_first_child (const string &aLabel)
void	select_parent ()
void	select_subtree (const string &aTree)
	directly jump down to this element if you know that it exists separate element names using a "/"
string	get_string (const string &aKey)
int	get_int (const string &aKey)
real	get_real (const string &aKey)
bool	get_bool (const string &aKey)
bool	key_exists (const string &aKey)

Detailed Description

XML document interface.

See also

BELFEM I/O Usage Guide

Constructor & Destructor Documentation

XML()

belfem::XML::XML	(	const string &	aPath,
		const FileMode	aMode = FileMode::OPEN_RDONLY )

~XML()

belfem::XML::~XML

(

)

Member Function Documentation

child_exists()

bool belfem::XML::child_exists

(

const string &

aLabel

)

test if at least one child of that name exists

get_bool()

bool belfem::XML::get_bool

(

const string &

aKey

)

get_int()

int belfem::XML::get_int

(

const string &

aKey

)

get_real()

real belfem::XML::get_real

(

const string &

aKey

)

get_string()

string belfem::XML::get_string

(

const string &

aKey

)

key_exists()

bool belfem::XML::key_exists

(

const string &

aKey

)

next_sibling_of_same_name()

bool belfem::XML::next_sibling_of_same_name

(

)

move to the next sibling of the same name; returns false ( selection unchanged ) if there is none

number_of_children() [1/2]

uint belfem::XML::number_of_children

(

)

cont the number of children in current tag

number_of_children() [2/2]

uint belfem::XML::number_of_children

(

const string &

aLabel

)

cont the number of children with that name

path()

const string & belfem::XML::path ( ) const

inline

return the path of this file

select_first_child()

void belfem::XML::select_first_child

(

const string &

aLabel

)

select_parent()

void belfem::XML::select_parent

(

)

select_subtree()

void belfem::XML::select_subtree

(

const string &

aTree

)

directly jump down to this element if you know that it exists separate element names using a "/"

---

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

• src/io/cl_XML.hpp
• src/io/cl_XML.cpp