Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

XmlCode Class Reference

#include <DataListenerSvc/XmlCode.h>

Collaboration diagram for XmlCode:

[legend]List of all members.

---

Detailed Description

XmlCode contains methods to write out XML tags.

It is used in conjunction with DataListenerSvc to create the XML log files which can be subsequently later parsed. Indent levels are specified manually by the user who must make sure everything is consistent.

Author:

Ben King

Date:

2006-07-06

Definition at line 21 of file XmlCode.h.

Public Member Functions
	XmlCode ()
	Standard constructor.
virtual	~XmlCode ()
	Destructor.
std::string	tagBegin (std::string data, int level, std::string attribute, std::string val)
	Return an opening XML tag which takes "attribute:value" pair.
std::string	tagBegin (std::string data, int level)
	return an opening XML tag
std::string	tagEnd (std::string data, int level)
	Will return a new line if the tag is given any indent, i.e.
std::string	data (std::string data)
	Return just the data given to the function.
std::string	declaration (std::string vers, std::string cod, std::string stand)
	XML declaration.
Private Attributes
std::string	tag

---

Constructor & Destructor Documentation

XmlCode::XmlCode

(

)

[inline]

Standard constructor.

Definition at line 25 of file XmlCode.h.

{};

virtual XmlCode::~XmlCode

(

)

[inline, virtual]

Destructor.

Definition at line 28 of file XmlCode.h.

{};

---

Member Function Documentation

std::string XmlCode::tagBegin	(	std::string	data,
		int	level,
		std::string	attribute,
		std::string	val
	)			[inline]

Return an opening XML tag which takes "attribute:value" pair.

Parameters:

	data	Name of the tag
	level	Amount of indenting to print, i.e. what generation of tag
	attribute	Attribute to include in tag (if used)
	val	Value of the Attribute (if used) with this class.

Definition at line 39 of file XmlCode.h.

References data().

Referenced by DataListenerSvc::writeXML().

  {
    std::string indent="";
    
    for (int i=0; i<level; i++){
      indent = indent + "  ";
    }
    
    return "\n" + indent + "<" + data + " " + attribute + "=\"" + val + "\">"; // A start tag will start a line
  }

std::string XmlCode::tagBegin	(	std::string	data,
		int	level
	)			[inline]

return an opening XML tag

Definition at line 51 of file XmlCode.h.

References data().

  {
    std::string indent="";
    
    for (int i=0; i<level; i++){
      indent = indent + "  ";
    }
    
    return "\n" + indent + "<" + data + ">"; // A start tag will start a line
  }

std::string XmlCode::tagEnd	(	std::string	data,
		int	level
	)			[inline]

Will return a new line if the tag is given any indent, i.e.

it is a parent tag

Definition at line 66 of file XmlCode.h.

References data().

Referenced by DataListenerSvc::writeXML().

  {

    if (level != 0) {
      std::string indent="";
    
      for (int i=0; i<level; i++){
        indent = indent + "  ";
      }

      return "\n" + indent + "</" + data + ">\n";
    }
    else {
      return "</" + data + ">"; // An end tag will end a line
    }

  }

std::string XmlCode::data

(

std::string

data

)

[inline]

Return just the data given to the function.

Definition at line 85 of file XmlCode.h.

Referenced by tagBegin(), tagEnd(), and DataListenerSvc::writeXML().

  {
    return data; // Data will come after a string so no new line
  }

std::string XmlCode::declaration	(	std::string	vers,
		std::string	cod,
		std::string	stand
	)			[inline]

XML declaration.

Parameters:

	vers	XML version number
	cod	XML encoding
	stand	XML standalone

Definition at line 99 of file XmlCode.h.

Referenced by DataListenerSvc::writeXML().

  {
    return "<?xml version=\"" + vers + "\" encoding=\"" + cod + "\" standalone=\"" + stand + "\"?>";
  }

---

Member Data Documentation

std::string XmlCode::tag [private]

Definition at line 112 of file XmlCode.h.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiMonitor/v1r4/src/DataListenerSvc/XmlCode.h

---