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 getWithDefault
def numChildren
def getChild
def numContentLines
def getContentLine
def toString
def header
def terminatedHeader
def footer
def isEmpty
def checkTag
def addAttribute
def addDouble
def addInt
def addBool
def addChild
def addContent
def __str__
def __init__
def deepCopy
def getTag
def hasAttribute
def getAttribute
def getRequired
def getRequiredDouble
def getRequiredInt
def getRequiredBool
def getWithDefault
def numChildren
def getChild
def numContentLines
def getContentLine
def toString
def header
def terminatedHeader
def footer
def isEmpty
def checkTag
def addAttribute
def addDouble
def addInt
def addBool
def addChild
def addContent
def __str__

Public Attributes

 this


Detailed Description

Representation of an XML data tree.

Member Function Documentation

def PyTrilinos::Teuchos::XMLObject::__init__ (   self,
  args 
)

__init__(self) -> XMLObject
__init__(self, string tag) -> XMLObject

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

def PyTrilinos::Teuchos::XMLObject::__init__ (   self,
  args 
)

__init__(self) -> XMLObject
__init__(self, string tag) -> XMLObject

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

def PyTrilinos::Teuchos::XMLObject::__str__ (   self,
  args 
)

__str__(self) -> 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::__str__ (   self,
  args 
)

__str__(self) -> 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(self, string name, string value)

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

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

def PyTrilinos::Teuchos::XMLObject::addAttribute (   self,
  args 
)

addAttribute(self, string name, string value)

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

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

def PyTrilinos::Teuchos::XMLObject::addBool (   self,
  args 
)

addBool(self, string name, bool val)

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

Add a bool as an attribute. 

def PyTrilinos::Teuchos::XMLObject::addBool (   self,
  args 
)

addBool(self, string 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(self, XMLObject child)

void
XMLObject::addChild(const XMLObject &child)

Add a child node to the node. 

def PyTrilinos::Teuchos::XMLObject::addChild (   self,
  args 
)

addChild(self, XMLObject child)

void
XMLObject::addChild(const XMLObject &child)

Add a child node to the node. 

def PyTrilinos::Teuchos::XMLObject::addContent (   self,
  args 
)

addContent(self, string contentLine)

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

Add a line of character content. 

def PyTrilinos::Teuchos::XMLObject::addContent (   self,
  args 
)

addContent(self, string contentLine)

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

Add a line of character content. 

def PyTrilinos::Teuchos::XMLObject::addDouble (   self,
  args 
)

addDouble(self, string name, double val)

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

Add a double as an attribute. 

def PyTrilinos::Teuchos::XMLObject::addDouble (   self,
  args 
)

addDouble(self, string 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(self, string name, int val)

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

Add an int as an attribute. 

def PyTrilinos::Teuchos::XMLObject::addInt (   self,
  args 
)

addInt(self, string 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(self, string expected)

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

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

def PyTrilinos::Teuchos::XMLObject::checkTag (   self,
  args 
)

checkTag(self, string expected)

void
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(self) -> XMLObject

XMLObject
XMLObject::deepCopy() const

Make a deep copy of this object. 

def PyTrilinos::Teuchos::XMLObject::deepCopy (   self,
  args 
)

deepCopy(self) -> XMLObject

XMLObject
XMLObject::deepCopy() const

Make a deep copy of this object. 

def PyTrilinos::Teuchos::XMLObject::footer (   self,
  args 
)

footer(self) -> string

std::string
XMLObject::footer() const

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

def PyTrilinos::Teuchos::XMLObject::footer (   self,
  args 
)

footer(self) -> string

std::string
XMLObject::footer() const

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

def PyTrilinos::Teuchos::XMLObject::getAttribute (   self,
  args 
)

getAttribute(self, string name) -> string

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

Return the value of the attribute with the specified name. 

def PyTrilinos::Teuchos::XMLObject::getAttribute (   self,
  args 
)

getAttribute(self, string name) -> string

const
std::string & 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(self, int i) -> XMLObject

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

Return the i-th child node. 

def PyTrilinos::Teuchos::XMLObject::getChild (   self,
  args 
)

getChild(self, int i) -> XMLObject

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

Return the i-th child node. 

def PyTrilinos::Teuchos::XMLObject::getContentLine (   self,
  args 
)

getContentLine(self, int i) -> string

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

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

def PyTrilinos::Teuchos::XMLObject::getContentLine (   self,
  args 
)

getContentLine(self, int i) -> string

const
std::string & 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(self, string name) -> string

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

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

def PyTrilinos::Teuchos::XMLObject::getRequired (   self,
  args 
)

getRequired(self, string name) -> string

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

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

def PyTrilinos::Teuchos::XMLObject::getRequiredBool (   self,
  args 
)

getRequiredBool(self, string name) -> bool

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

Get a required attribute, returning it as a bool. 

def PyTrilinos::Teuchos::XMLObject::getRequiredBool (   self,
  args 
)

getRequiredBool(self, string name) -> bool

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

Get a required attribute, returning it as a bool. 

def PyTrilinos::Teuchos::XMLObject::getRequiredDouble (   self,
  args 
)

getRequiredDouble(self, string name) -> double

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

Get a required attribute, returning it as a double. 

def PyTrilinos::Teuchos::XMLObject::getRequiredDouble (   self,
  args 
)

getRequiredDouble(self, string 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(self, string name) -> int

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

Get a required attribute, returning it as an int. 

def PyTrilinos::Teuchos::XMLObject::getRequiredInt (   self,
  args 
)

getRequiredInt(self, string 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(self) -> string

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

Return the tag of the current node. 

def PyTrilinos::Teuchos::XMLObject::getTag (   self,
  args 
)

getTag(self) -> string

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

Return the tag of the current node. 

def PyTrilinos::Teuchos::XMLObject::getWithDefault (   self,
  args 
)

getWithDefault(self, string name, string defaultValue) -> string

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. 

def PyTrilinos::Teuchos::XMLObject::getWithDefault (   self,
  args 
)

getWithDefault(self, string name, string defaultValue) -> string

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. 

def PyTrilinos::Teuchos::XMLObject::hasAttribute (   self,
  args 
)

hasAttribute(self, string name) -> bool

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

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

def PyTrilinos::Teuchos::XMLObject::hasAttribute (   self,
  args 
)

hasAttribute(self, string name) -> bool

bool
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(self) -> string

std::string
XMLObject::header() const

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

def PyTrilinos::Teuchos::XMLObject::header (   self,
  args 
)

header(self) -> string

std::string
XMLObject::header() const

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

def PyTrilinos::Teuchos::XMLObject::isEmpty (   self,
  args 
)

isEmpty(self) -> bool

bool
Teuchos::XMLObject::isEmpty() const

Find out if a node is empty. 

def PyTrilinos::Teuchos::XMLObject::isEmpty (   self,
  args 
)

isEmpty(self) -> bool

bool
Teuchos::XMLObject::isEmpty() const

Find out if a node is empty. 

def PyTrilinos::Teuchos::XMLObject::numChildren (   self,
  args 
)

numChildren(self) -> int

int
XMLObject::numChildren() const

Return the number of child nodes owned by this node. 

def PyTrilinos::Teuchos::XMLObject::numChildren (   self,
  args 
)

numChildren(self) -> int

int
XMLObject::numChildren() const

Return the number of child nodes owned by this node. 

def PyTrilinos::Teuchos::XMLObject::numContentLines (   self,
  args 
)

numContentLines(self) -> int

int
XMLObject::numContentLines() const

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

def PyTrilinos::Teuchos::XMLObject::numContentLines (   self,
  args 
)

numContentLines(self) -> int

int
XMLObject::numContentLines() const

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

def PyTrilinos::Teuchos::XMLObject::terminatedHeader (   self,
  args 
)

terminatedHeader(self) -> string

std::string XMLObject::terminatedHeader() const

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

def PyTrilinos::Teuchos::XMLObject::terminatedHeader (   self,
  args 
)

terminatedHeader(self) -> string

std::string XMLObject::terminatedHeader() const

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

def PyTrilinos::Teuchos::XMLObject::toString (   self,
  args 
)

toString(self) -> string

std::string
XMLObject::toString() const

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

def PyTrilinos::Teuchos::XMLObject::toString (   self,
  args 
)

toString(self) -> string

std::string
XMLObject::toString() const

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


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

Generated on Thu Dec 17 11:00:23 2009 for PyTrilinos by  doxygen 1.5.9