PyTrilinos  Development
 All Classes Functions
Public Member Functions | Public Attributes
PyTrilinos.Teuchos.XMLObject Class Reference
Inheritance diagram for PyTrilinos.Teuchos.XMLObject:
Inheritance graph
[legend]
Collaboration diagram for PyTrilinos.Teuchos.XMLObject:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def deepCopy
def getTag
def hasAttribute
def getAttribute
def getRequired
def getRequiredDouble
def getRequiredInt
def getRequiredBool
def numChildren
def getChild
def findFirstChild
def numContentLines
def getContentLine
def toString
def header
def terminatedHeader
def footer
def isEmpty
def checkTag
def addDouble
def addInt
def addBool
def addChild
def addContent
def addAttribute
def getWithDefault
def __str__

Public Attributes

 this

Detailed Description

Representation of an XML data tree.

Constructor & Destructor Documentation

def PyTrilinos.Teuchos.XMLObject.__init__ (   self,
  args 
)
__init__(Teuchos::XMLObject self) -> XMLObject
__init__(Teuchos::XMLObject self, std::string const & tag) -> XMLObject

The constructor that takes an ``XMLObjectImplem*`` argument has been
removed.  The ``XMLObjectImplem`` class is hidden from the python
user.

Member Function Documentation

def PyTrilinos.Teuchos.XMLObject.__str__ (   self,
  args 
)
__str__(XMLObject self) -> std::string

The ``__str__()`` method is provided so that it is possible to
``print`` an ``XMLObject`` object.  It returns the same string as the
``toString()`` method, but if ``toString()`` raises an exception (such
as when the ``XMLObject`` is empty), the ``__str__()`` method returns
the empty string.
def PyTrilinos.Teuchos.XMLObject.addAttribute (   self,
  args 
)
addAttribute(XMLObject self, std::string const & name, PyObject * value)

The ``addAttribute(name, value)`` method converts the value to its
string representation and adds it as an attribute to the XML object.
def PyTrilinos.Teuchos.XMLObject.addBool (   self,
  args 
)
addBool(XMLObject self, std::string const & name, bool val)

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

Add a bool as an attribute. 
def PyTrilinos.Teuchos.XMLObject.addChild (   self,
  args 
)
addChild(XMLObject self, XMLObject child)

void
Teuchos::XMLObject::addChild(const XMLObject &child)

Add a child node to the node. 
def PyTrilinos.Teuchos.XMLObject.addContent (   self,
  args 
)
addContent(XMLObject self, std::string const & contentLine)

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

Add a line of character content. 
def PyTrilinos.Teuchos.XMLObject.addDouble (   self,
  args 
)
addDouble(XMLObject self, std::string const & name, double val)

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

Add a double as an attribute. 
def PyTrilinos.Teuchos.XMLObject.addInt (   self,
  args 
)
addInt(XMLObject self, std::string const & name, int val)

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

Add an int as an attribute. 
def PyTrilinos.Teuchos.XMLObject.checkTag (   self,
  args 
)
checkTag(XMLObject self, std::string const & expected)

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

Check that a tag is equal to an expected std::string. 
def PyTrilinos.Teuchos.XMLObject.deepCopy (   self,
  args 
)
deepCopy(XMLObject self) -> XMLObject

XMLObject
Teuchos::XMLObject::deepCopy() const

Make a deep copy of this object. 
def PyTrilinos.Teuchos.XMLObject.findFirstChild (   self,
  args 
)
findFirstChild(XMLObject self, std::string tagName) -> int

int
Teuchos::XMLObject::findFirstChild(std::string tagName) const

Returns the index of the first child found with the given tag name.
Returns -1 if no child is found. 
def PyTrilinos.Teuchos.XMLObject.footer (   self,
  args 
)
footer(XMLObject self) -> std::string

std::string
Teuchos::XMLObject::footer() const

Write the footer for this object to a std::string. 
def PyTrilinos.Teuchos.XMLObject.getAttribute (   self,
  args 
)
getAttribute(XMLObject self, std::string const & name) -> std::string const &

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

Return the value of the attribute with the specified name. 
def PyTrilinos.Teuchos.XMLObject.getChild (   self,
  args 
)
getChild(XMLObject self, int i) -> XMLObject

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

Return the i-th child node. 
def PyTrilinos.Teuchos.XMLObject.getContentLine (   self,
  args 
)
getContentLine(XMLObject self, int i) -> std::string const &

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

Return the i-th line of character content stored in this node. 
def PyTrilinos.Teuchos.XMLObject.getRequired (   self,
  args 
)
getRequired(XMLObject self, std::string const & name) -> std::string const &

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

Get a required attribute, returning it as T. 
getRequiredBool(XMLObject self, std::string const & name) -> bool

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

Get a required attribute, returning it as a bool. 
getRequiredDouble(XMLObject self, std::string const & name) -> double

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

Get a required attribute, returning it as a double. 
def PyTrilinos.Teuchos.XMLObject.getRequiredInt (   self,
  args 
)
getRequiredInt(XMLObject self, std::string const & name) -> int

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

Get a required attribute, returning it as an int. 
def PyTrilinos.Teuchos.XMLObject.getTag (   self,
  args 
)
getTag(XMLObject self) -> std::string const &

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

Return the tag of the current node. 
def PyTrilinos.Teuchos.XMLObject.getWithDefault (   self,
  args 
)
getWithDefault(XMLObject self, std::string const & name, PyObject * defaultValue) -> PyObject *

The ``getWithDefault(name, defaultValue)`` method will return the
typed value of attribute ``name``.  If the attribute does not exist,
then ``defaultValue``, which can be any python object, is returned.
If the underlying object cannot be converted to a python object, then
a python string is returned.
def PyTrilinos.Teuchos.XMLObject.hasAttribute (   self,
  args 
)
hasAttribute(XMLObject self, std::string const & name) -> bool

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

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

def PyTrilinos.Teuchos.XMLObject.header (   self,
  args 
)
header(XMLObject self) -> std::string

std::string
Teuchos::XMLObject::header() const

Write the header for this object to a std::string. 
def PyTrilinos.Teuchos.XMLObject.isEmpty (   self,
  args 
)
isEmpty(XMLObject self) -> bool

bool
Teuchos::XMLObject::isEmpty() const

Find out if a node is empty. 
def PyTrilinos.Teuchos.XMLObject.numChildren (   self,
  args 
)
numChildren(XMLObject self) -> int

int
Teuchos::XMLObject::numChildren() const

Return the number of child nodes owned by this node. 
numContentLines(XMLObject self) -> int

int
Teuchos::XMLObject::numContentLines() const

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

terminatedHeader(XMLObject self) -> std::string

std::string Teuchos::XMLObject::terminatedHeader() const

Write the header for this object to a std::string. 
def PyTrilinos.Teuchos.XMLObject.toString (   self,
  args 
)
toString(XMLObject self) -> std::string

std::string
Teuchos::XMLObject::toString() const

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

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