XMLTag Class Reference

#include <XMLTag.hpp>

Collaboration diagram for XMLTag:

[legend]

List of all members.

Public Member Functions
ReferenceCounting< XMLAttribute >	findAttribute (const std::string &name, const std::string &defaultValue="") const
void	close (const std::string &name)
void	add (ReferenceCounting< XMLAttribute > xmlAttribute)
void	add (ReferenceCounting< XMLContentBase > xmlContent)
ReferenceCounting< XMLContentBase >	content ()
ConstReferenceCounting < XMLContentBase >	content () const
const std::string &	name () const
	XMLTag (const std::string &name)
Private Types
typedef std::map< std::string, ReferenceCounting < XMLAttribute > >	AttributeList
Private Attributes
const std::string	__name
AttributeList	__attributes
ReferenceCounting< XMLContentBase >	__content
Friends
std::ostream &	operator<< (std::ostream &os, const XMLTag &xmlTag)

---

Detailed Description

Definition at line 42 of file XMLTag.hpp.

---

Member Typedef Documentation

typedef std::map<std::string, ReferenceCounting<XMLAttribute> > XMLTag::AttributeList [private]

Definition at line 46 of file XMLTag.hpp.

---

Constructor & Destructor Documentation

XMLTag::XMLTag

(

const std::string &

name

)

[inline]

Constructor

Parameters:

name

name of the tag to build

Definition at line 183 of file XMLTag.hpp.

    : __name(name),
      __content(0)
  {
    ;
  }

---

Member Function Documentation

ReferenceCounting<XMLAttribute> XMLTag::findAttribute	(	const std::string &	name,
		const std::string &	defaultValue = ""
	)			const [inline]

Looks for an attribute according to its name

Parameters:

	name	name of the attribute
	defaultValue	value to use if attribute is not found

Returns:

a pointer to the attribute

Definition at line 66 of file XMLTag.hpp.

References __attributes, ErrorHandler::normal, and stringify().

  {
    AttributeList::const_iterator attribute = __attributes.find(name);
    if (attribute == __attributes.end()) {
      if (defaultValue.size() == 0) {
        throw ErrorHandler(__FILE__,__LINE__,
                           "cannot find mandatory attribute '"+name+"' into <"+stringify(*this)+">",
                           ErrorHandler::normal);
      } else {
        return new XMLAttribute(name,defaultValue);
      }
    }

    return attribute->second;
  }

Here is the call graph for this function:

void XMLTag::close

(

const std::string &

name

)

[inline]

Closes a tag checking that the closure fits the opening

Parameters:

name

closed tag name

Definition at line 108 of file XMLTag.hpp.

References __name, and ErrorHandler::normal.

  {
    if (__name != name) {
      throw ErrorHandler(__FILE__,__LINE__,
                         "tag <"+__name+"> closed by </"+name+">",
                         ErrorHandler::normal);
    }
  }

void XMLTag::add

(

ReferenceCounting< XMLAttribute >

xmlAttribute

)

[inline]

Adds an attribute to a tag

Parameters:

xmlAttribute

given attribute

Definition at line 122 of file XMLTag.hpp.

References __attributes, __name, and ErrorHandler::normal.

Referenced by WriterVTK::__proceed().

  {
    if (__attributes.find(xmlAttribute->name()) != __attributes.end()) {
      throw ErrorHandler(__FILE__,__LINE__,
                         "duplicated attribute '"+
                         xmlAttribute->name()+
                         "' in tag '"+__name+'\'',
                         ErrorHandler::normal);
    }
    __attributes[xmlAttribute->name()] = xmlAttribute;
  }

void XMLTag::add

(

ReferenceCounting< XMLContentBase >

xmlContent

)

[inline]

Adds a content

Parameters:

xmlContent

given content

Definition at line 139 of file XMLTag.hpp.

References __content, and ASSERT.

  {
    ASSERT(__content == 0);
    __content = xmlContent;
  }

ReferenceCounting<XMLContentBase> XMLTag::content

(

)

[inline]

Access to the content of the tag

Returns:

__content

Definition at line 151 of file XMLTag.hpp.

References __content.

  {
    return __content;
  }

ConstReferenceCounting<XMLContentBase> XMLTag::content

(

)

const [inline]

Read only access to the content of the tag

Returns:

__content

Definition at line 162 of file XMLTag.hpp.

References __content.

  {
    return __content;
  }

const std::string& XMLTag::name

(

)

const [inline]

Gets the tag name

Returns:

__name

Definition at line 173 of file XMLTag.hpp.

References __name.

  {
    return __name;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const XMLTag &	xmlTag
	)			[friend]

Writes a tag to a stream

Parameters:

	os	given output stream
	xmlTag	the tag to write

Returns:

os

Definition at line 91 of file XMLTag.hpp.

  {
    os << xmlTag.__name;
    for (AttributeList::const_iterator i = xmlTag.__attributes.begin();
         i != xmlTag.__attributes.end(); ++i) {
      os << ' ' << i->second->name() << "=\""
         << i->second->value() << '"';
    }
    return os;
  }

---

Member Data Documentation

const std::string XMLTag::__name [private]

name of the tag

Definition at line 49 of file XMLTag.hpp.

Referenced by add(), close(), and name().

AttributeList XMLTag::__attributes [private]

list of attributes

Definition at line 51 of file XMLTag.hpp.

Referenced by add(), and findAttribute().

ReferenceCounting<XMLContentBase> XMLTag::__content [private]

content of the tag if any

Definition at line 54 of file XMLTag.hpp.

Referenced by add(), and content().

---

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

• XMLTag.hpp