core.xdmf.XdmfItem Class Reference

The base class for all XDMF XML elements. More...

Inheritance diagram for core.xdmf.XdmfItem:

Collaboration diagram for core.xdmf.XdmfItem:

Public Member Functions
def	xml_tag (self)
	Return the XML tag for the XDMF item as a string. More...
def	create_xml_element (self)
	Return the XDMF item as an XML element node in the XML document tree. More...

Detailed Description

The base class for all XDMF XML elements.

Member Function Documentation

create_xml_element()

def core.xdmf.XdmfItem.create_xml_element

(

self

)

Return the XDMF item as an XML element node in the XML document tree.

    If the node is the root element of the XML document, it can be written
    to a file as:

    root = obj.create_xml_element()
    ElementTree(root).write(file_or_filename)

    If it is a child node, it can be appended to its parent as:

    child = obj.create_xml_element()
    parent.append(child)

    An entire XML document representing an XDMF model is built from a set
    of XdmfItem objects by combining their XML nodes in an XML tree.

Reimplemented in core.xdmf.Xdmf, core.xdmf.Domain, core.xdmf.UniformGrid, core.xdmf.TemporalGrid, core.xdmf.SpatialGrid, core.xdmf.GeometrycalObjectData, core.xdmf.NodalData, core.xdmf.HDF5UniformDataItem, core.xdmf.UniformMeshTopology, core.xdmf.Geometry, and core.xdmf.Time.

xml_tag()

def core.xdmf.XdmfItem.xml_tag

(

self

)

Return the XML tag for the XDMF item as a string.

    Every XML element is identified by a tag. Valid tags are specified by
    the XDMF model format.

Reimplemented in core.xdmf.Xdmf, core.xdmf.Domain, core.xdmf.Geometry, core.xdmf.Time, core.xdmf.Grid, core.xdmf.Topology, core.xdmf.Attribute, and core.xdmf.DataItem.

---

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

• /home/runner/work/Documentation/Documentation/master/applications/HDF5Application/python_scripts/core/xdmf.py