cXMLElement Class Reference¶

Should be redefined in subclasses to create an exact copy of this object. The default implementation just throws an error, to indicate that the method was not redefined.

Reimplemented from cObject.

Returns a one-line description of the element.

Reimplemented from cObject.

Enables traversing the object tree, performing some operation on each object. The operation is encapsulated in the particular subclass of cVisitor.

This method should be redefined in every subclass to call v->visit(obj) for every obj object contained.

Reimplemented from cObject.

Returns the element name.

References cNamedObject::getName().

Returns the file name this element originally came from.

Returns the line number in the file this element originally came from.

Returns a string containing a file/line position showing where this element originally came from.

Returns text node in the element, or nullptr otherwise. (Mixing text and child elements is not supported.)

Returns the value of the attribute with the given name. It returns nullptr if the given attribute is not found.

Returns true if the element has attributes

Returns attributes in an a std::map.

Returns the subtree as an XML fragment.

Returns the parent element, or nullptr if this element has no parent.

Returns true if the element has child elements.

Returns pointer to the first child element, or nullptr if this element has no children.

Returns pointer to the last child element, or nullptr if this element has no children.

Returns pointer to the next sibling of this element (i.e. the next child in the parent element). Returns nullptr if there're no subsequent elements.

getFirstChild() and getNextSibling() can be used to loop through the child list:

Returns pointer to the previous sibling of this element (i.e. the previous child in the parent element). Returns nullptr if there're no elements before this one.

Returns pointer to the first child element with the given tag name, or nullptr if this element has no such children.

Returns pointer to the next sibling of this element with the given tag name. Return nullptr if there're no such subsequent elements.

getFirstChildWithTag() and getNextSiblingWithTag() are a convient way to loop through elements with a certain tag name in the child list:

Returns list of child elements.

Returns list of child elements with the given tag name.

Returns list of contained elements with the given tag name, in preorder traversal order.

Returns find first child element with the given tagname and the given attribute present, and (optionally) having the given value. tagname might be nullptr – then any element with the given attribute will be accepted. Returns nullptr if not found.

Returns the first element which has an "id" attribute with the given value. ("id" attributes are supposed to be unique in an XML document.) Returns nullptr if not found.

Returns the first element designated by the given path expression. ("First" in the sense of preorder depth-first traversal.) Path expressions must be given in an XPath-like notation: they consist of path components (or "steps") separated by "/" or "//". A path component can be an element tag name, "*", "." or ".."; tag name and "*" can have an optional predicate in the form "[position]" or "[@attribute='value']". "/" means child element; "//" means a element any levels under the current one; ".", ".." and "*" mean what you expect them to: current element, parent element, element with any tag name.

Examples:

• . – this element
• ./foo – first "foo" child of this element
• foo – same as ./foo (initial ./ can be omitted)
• ./foo – first "foo" child of this element
• ./foo/bar – first "bar" child of first "foo" child of this element
• .//bar – first "bar" anywhere under this element (depth-first search!)
• ./ * /bar – first "bar" child two levels below this element (remove the spaces!)
• ./foo[0] – first "foo" child of this element
• ./foo[1] – second "foo" child of this element
• ‘./foo[@color ='green’] -- first "foo" child which has attribute "color" with value "green"
• .//bar[1] -- a "bar" anywhere under this element which is the second "bar" among its siblings
• .// * [@color ='yellow'] -- an element anywhere under this element with attribute color="yellow" (remove the spaces!)
• .// * [@color ='yellow']/foo/bar` – first "bar" child of first "foo" child of a "yellow-colored" element (remove the spaces!)

The method throws an exception if the path expression is invalid, and returns nullptr if the element is not found.