Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Examples | Search for 

Teuchos::XMLObject Class Reference

Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object, allowing storage by reference. More...

#include <Teuchos_XMLObject.hpp>

List of all members.

Public Member Functions

Constructors
 XMLObject ()
 Empty constructor.
 XMLObject (const std::string &tag)
 Construct using a node labeled by tag.
 XMLObject (XMLObjectImplem *ptr)
 Construct with a pointer to the low-level representation.
Copy methods
XMLObject deepCopy () const
 Make a deep copy of this object.
Data Access methods
const std::string & getTag () const
 Return the tag of the current node.
bool hasAttribute (const std::string &name) const
 Find out if the current node has an attribute of the specified name.
const std::string & getAttribute (const std::string &name) const
 Return the value of the attribute with the specified name.
const std::string & getRequired (const std::string &name) const
 Get an attribute, throwing an std::exception if it is not found.
double getRequiredDouble (const std::string &name) const
 Get a required attribute, returning it as a double.
int getRequiredInt (const std::string &name) const
 Get a required attribute, returning it as an int.
bool getRequiredBool (const std::string &name) const
 Get a required attribute, returning it as a bool.
std::string getWithDefault (const std::string &name, const std::string &defaultValue) const
 Get an attribute, assigning a default value if the requested attribute does not exist.
int numChildren () const
 Return the number of child nodes owned by this node.
const XMLObject & getChild (int i) const
 Return the i-th child node.
int numContentLines () const
 Return the number of lines of character content stored in this node.
const std::string & getContentLine (int i) const
 Return the i-th line of character content stored in this node.
std::string toString () const
 Represent this node and its children as a std::string.
void print (std::ostream &os, int indent) const
 Print this node and its children to stream with the given indentation.
std::string header () const
 Write the header for this object to a std::string.
std::string terminatedHeader () const
 Write the header for this object to a std::string.
std::string footer () const
 Write the footer for this object to a std::string.
bool isEmpty () const
 Find out if a node is empty.
void checkTag (const std::string &expected) const
 Check that a tag is equal to an expected std::string.
Tree-Assembly methods
void addAttribute (const std::string &name, const std::string &value)
 Add an attribute to the current node's atribute list.
void addDouble (const std::string &name, double val)
 Add a double as an attribute.
void addInt (const std::string &name, int val)
 Add an int as an attribute.
void addBool (const std::string &name, bool val)
 Add a bool as an attribute.
void addChild (const XMLObject &child)
 Add a child node to the node.
void addContent (const std::string &contentLine)
 Add a line of character content.

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const XMLObject &xml)
 Write XMLObject to os stream.
std::string toString (const XMLObject &xml)
 Write XMLObject to std::string.

Detailed Description

Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object, allowing storage by reference.

Constructor & Destructor Documentation

Teuchos::XMLObject::XMLObject (   )  [inline]
 

Empty constructor.

XMLObject::XMLObject (  const std::string &  tag  ) 
 

Construct using a node labeled by tag.

XMLObject::XMLObject (  XMLObjectImplem *  ptr  ) 
 

Construct with a pointer to the low-level representation.

This is used to allow construction of an XMLObject from the XMLObjectImplem* return value of ExceptionBase::toXML().

Member Function Documentation

XMLObject XMLObject::deepCopy (   )  const
 

Make a deep copy of this object.

const std::string & XMLObject::getTag (   )  const
 

Return the tag of the current node.

bool XMLObject::hasAttribute (  const std::string &  name  )  const
 

Find out if the current node has an attribute of the specified name.

const std::string & XMLObject::getAttribute (  const std::string &  name  )  const
 

Return the value of the attribute with the specified name.

const std::string & XMLObject::getRequired (  const std::string &  name  )  const
 

Get an attribute, throwing an std::exception if it is not found.

double Teuchos::XMLObject::getRequiredDouble (  const std::string &  name  )  const [inline]
 

Get a required attribute, returning it as a double.

int Teuchos::XMLObject::getRequiredInt (  const std::string &  name  )  const [inline]
 

Get a required attribute, returning it as an int.

bool XMLObject::getRequiredBool (  const std::string &  name  )  const
 

Get a required attribute, returning it as a bool.

std::string XMLObject::getWithDefault (  const std::string &  name,
const std::string &  defaultValue
)  const
 

Get an attribute, assigning a default value if the requested attribute does not exist.

int XMLObject::numChildren (   )  const
 

Return the number of child nodes owned by this node.

const XMLObject & XMLObject::getChild (  int  i  )  const
 

Return the i-th child node.

int XMLObject::numContentLines (   )  const
 

Return the number of lines of character content stored in this node.

const std::string & XMLObject::getContentLine (  int  i  )  const
 

Return the i-th line of character content stored in this node.

std::string XMLObject::toString (   )  const
 

Represent this node and its children as a std::string.

void XMLObject::print (  std::ostream &  os,
int  indent
)  const
 

Print this node and its children to stream with the given indentation.

std::string XMLObject::header (   )  const
 

Write the header for this object to a std::string.

std::string XMLObject::terminatedHeader (   )  const
 

Write the header for this object to a std::string.

std::string XMLObject::footer (   )  const
 

Write the footer for this object to a std::string.

bool Teuchos::XMLObject::isEmpty (   )  const [inline]
 

Find out if a node is empty.

void XMLObject::checkTag (  const std::string &  expected  )  const
 

Check that a tag is equal to an expected std::string.

void XMLObject::addAttribute (  const std::string &  name,
const std::string &  value
) 
 

Add an attribute to the current node's atribute list.

void Teuchos::XMLObject::addDouble (  const std::string &  name,
double  val
)  [inline]
 

Add a double as an attribute.

void Teuchos::XMLObject::addInt (  const std::string &  name,
int  val
)  [inline]
 

Add an int as an attribute.

void Teuchos::XMLObject::addBool (  const std::string &  name,
bool  val
)  [inline]
 

Add a bool as an attribute.

void XMLObject::addChild (  const XMLObject &  child  ) 
 

Add a child node to the node.

void XMLObject::addContent (  const std::string &  contentLine  ) 
 

Add a line of character content.

Friends And Related Function Documentation

std::ostream & operator<< (  std::ostream &  os,
const XMLObject &  xml
)  [related]
 

Write XMLObject to os stream.

std::string toString (  const XMLObject &  xml  )  [related]
 

Write XMLObject to std::string.

The documentation for this class was generated from the following files:
Generated on Sun Nov 23 12:11:33 2008 for Teuchos - Trilinos Tools Package by  doxygen 1.3.9.1