1#ifndef SimTK_SimTKCOMMON_XML_H_
2#define SimTK_SimTKCOMMON_XML_H_
56class attribute_iterator;
65class element_iterator;
518const Impl& getImpl()
const {assert(impl);
return *impl;}
519Impl& updImpl() {assert(impl);
return *impl;}
521Document& unconst()
const {
return *
const_cast<Document*
>(
this);}
563{
if (&src!=
this) {clear(); tiAttr=src.tiAttr;}
return *
this; }
614explicit Attribute(TiXmlAttribute* attr) {tiAttr=attr;}
615const TiXmlAttribute& getTiAttr()
const {assert(tiAttr);
return *tiAttr;}
616TiXmlAttribute& updTiAttr() {assert(tiAttr);
return *tiAttr;}
622void setTiAttrPtr(TiXmlAttribute* attr) {tiAttr=attr;}
623const TiXmlAttribute* getTiAttrPtr()
const {
return tiAttr;}
624TiXmlAttribute* updTiAttrPtr() {
return tiAttr;}
626Attribute& unconst()
const {
return *
const_cast<Attribute*
>(
this);}
628TiXmlAttribute* tiAttr;
650:
public std::iterator<std::bidirectional_iterator_tag, Attribute> {
661: attr(src->updTiAttrPtr()) {}
667{ attr.setTiAttrPtr(src->updTiAttrPtr());
return *
this; }
700{
return other.attr==attr; }
703{
return other.attr!=attr; }
762{
if (&src!=
this) {clear(); tiNode=src.tiNode;}
return *
this; }
857explicit Node(TiXmlNode* tiNode) : tiNode(tiNode) {}
859const TiXmlNode& getTiNode()
const {assert(tiNode);
return *tiNode;}
860TiXmlNode& updTiNode() {assert(tiNode);
return *tiNode;}
865void setTiNodePtr(TiXmlNode* node) {tiNode=node;}
866const TiXmlNode* getTiNodePtr()
const {
return tiNode;}
867TiXmlNode* updTiNodePtr() {
return tiNode;}
879Node& unconst()
const {
return *
const_cast<Node*
>(
this);}
905:
public std::iterator<std::bidirectional_iterator_tag, Node> {
911: node(node), allowed(allowed) {}
916: node(*src), allowed(src.allowed) {}
922{ node = *src; allowed = src.allowed;
return *
this; }
940: node(tiNode), allowed(allowed) {}
942{ node.setTiNodePtr(tiNode); }
983{ upcast()=src; tag = src.tag;
return *
this; }
990inline Element* operator->()
const;
993{
return other.upcast()==upcast();}
995{
return other.upcast()!=upcast();}
1003void reassign(TiXmlElement* tiElt)
1004{ upcast().
reassign((TiXmlNode*)tiElt); }
1006const node_iterator& upcast()
const
1007{
return *
static_cast<const node_iterator*
>(
this); }
1008node_iterator& upcast()
1009{
return *
static_cast<node_iterator*
>(
this); }
1159{ setValue(
String(value)); }
1168{ T out; convertStringTo(getValue(),out);
return out;}
1173{ convertStringTo(getValue(),out); }
1184{
return unconst().getRequiredElement(tag).getValue(); }
1191{
const Element opt(unconst().getOptionalElement(tag));
1204{ T out; convertStringTo(unconst().getRequiredElementValue(tag), out);
1220{
const Element opt(unconst().getOptionalElement(tag));
1221 if (!opt.
isValid())
return def;
1222 T out; convertStringTo(opt.
getValue(), out);
return out; }
1248{
return unconst().getRequiredAttribute(name).getValue(); }
1258{ T out; convertStringTo(getRequiredAttributeValue(name),out);
return out; }
1268{
Attribute attr = unconst().getOptionalAttribute(name);
1269 if (!attr.
isValid())
return def;
1284{
Attribute attr = unconst().getOptionalAttribute(name);
1285 if (!attr.
isValid())
return def;
1286 T out; convertStringTo(attr.
getValue(), out);
return out; }
1364{
return Array_<Node>(node_begin(allowed), node_end()); }
1404explicit Element(TiXmlElement* tiElt)
1405:
Node(reinterpret_cast<TiXmlNode*>(tiElt)) {}
1407TiXmlElement& updTiElement()
1408{
return reinterpret_cast<TiXmlElement&
>(updTiNode()); }
1409const TiXmlElement& getTiElement()
const
1410{
return reinterpret_cast<const TiXmlElement&
>(getTiNode()); }
1415const TiXmlElement* getTiElementPtr()
const
1416{
return reinterpret_cast<const TiXmlElement*
>(getTiNodePtr()); }
1417TiXmlElement* updTiElementPtr()
1418{
return reinterpret_cast<TiXmlElement*
>(updTiNodePtr()); }
1419void setTiElementPtr(TiXmlElement* elt)
1420{ setTiNodePtr(
reinterpret_cast<TiXmlNode*
>(elt)); }
1422Element& unconst()
const {
return *
const_cast<Element*
>(
this);}
1487explicit Text(TiXmlText* tiText)
1488:
Node(reinterpret_cast<TiXmlNode*>(tiText)) {}
1532explicit Comment(TiXmlComment* tiComment)
1533:
Node(reinterpret_cast<TiXmlNode*>(tiComment)) {}
1592explicit Unknown(TiXmlUnknown* tiUnknown)
1593:
Node(reinterpret_cast<TiXmlNode*>(tiUnknown)) {}
1621template <
class T>
inline Xml::Element
1623 std::ostringstream os;
1625 return Xml::Element(name.empty()?
"value":name, os.str());
1631template <
class T>
inline
1633 ->
decltype(std::declval<T>().toXmlElement(name)) {
1634 return thing.toXmlElement(name);
1640template <
class T>
inline
1643 return toXmlElement(thing, name);
1667template <
class T>
inline void
1669 const std::string& requiredName=
"") {
1670 if (!requiredName.empty()) {
1673 "Expected element name '%s' but got '%s'.", requiredName.c_str(),
1676 std::istringstream is(elt.
getValue());
1679 "Failed to read an object of type T='%s' from element value '%s' "
1680 "using readUnformatted<T>().",
1687template <
class T>
inline
1689 const std::string& requiredTag,
bool)
1690 ->
decltype(std::declval<T>().fromXmlElement(elt,requiredTag)) {
1691 return thing.fromXmlElement(elt,requiredTag);
1697template <
class T>
inline
1699 const std::string& requiredTag,
int)
1701 fromXmlElement(thing, elt, requiredTag);
1719template <
class T,
class X>
1721 const std::string& name=
"") {
1722 static const int version = 1;
1726 for (
const auto& v : thing)
1727 e.
appendNode(toXmlElementHelper(v,
"",
true));
1736template <
class T,
class X>
1738 const std::string& name=
"") {
1747template <
class T,
class X>
1749 const std::string& name=
"") {
This file defines the Array_<T,X> class and related support classes including base classes ArrayViewC...
#define SimTK_ERRCHK2_ALWAYS(cond, whereChecked, fmt, a1, a2)
Definition: ExceptionMacros.h:289
Mandatory first inclusion for any Simbody source or header file.
#define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:224
This Array_ helper class is the base class for ArrayView_ which is the base class for Array_; here we...
Definition: Array.h:324
Xml::Element toXmlElement(const ArrayViewConst_< T, X > &thing, const std::string &name="")
Partial specialization for XML serialization of ArrayViewConst_ objects.
Definition: Xml.h:1720
This Array_ helper class is the base class for Array_, extending ArrayViewConst_ to add the ability t...
Definition: Array.h:845
Xml::Element toXmlElement(const ArrayView_< T, X > &thing, const std::string &name="")
Partial specialization for XML serialization of ArrayView_ objects.
Definition: Xml.h:1737
The Array_<T> container class is a plug-compatible replacement for the C++ standard template library ...
Definition: Array.h:1520
Xml::Element toXmlElement(const Array_< T, X > &thing, const std::string &name="")
Partial specialization for XML serialization of Array_ objects.
Definition: Xml.h:1748
SimTK::String is a plug-compatible std::string replacement (plus some additional functionality) inten...
Definition: String.h:62
Elements can have attributes, which are name="value" pairs that appear within the element start tag i...
Definition: Xml.h:547
~Attribute()
The Attribute handle destructor does not recover heap space so if you create orphan attributes and th...
Definition: Xml.h:567
Attribute & setName(const String &name)
If this is a valid attribute handle, change its name.
Attribute(const Attribute &src)
Copy constructor is shallow; that is, this handle will refer to the same attribute as the source.
Definition: Xml.h:557
bool operator==(const Attribute &attr) const
Comparison operators return true if the same attribute is being referenced or both handles are empty.
Definition: Xml.h:606
const String & getValue() const
If this is a valid attribute handle, get the value of the attribute as a String, not including the qu...
const String & getName() const
If this is a valid attribute handle, get the name of the attribute.
void clear()
This method restores the Attribute handle to its default-constructed state but does not recover any h...
bool isValid() const
Is this handle currently holding an attribute?
Definition: Xml.h:569
void writeToString(String &out) const
Serialize this attribute to the given String.
void clearOrphan()
This method explicitly frees the heap space for an orphan attribute that was created but never insert...
bool operator!=(const Attribute &attr) const
Definition: Xml.h:607
Attribute()
Default constructor creates a null Attribute handle.
Definition: Xml.h:550
Attribute(const String &name, const String &value)
Create a new orphan Attribute, that is, an Attribute that is not owned by any Xml Element.
Attribute & operator=(const Attribute &src)
Copy assignment is shallow; the handle is first cleared and then will refer to the same attribute as ...
Definition: Xml.h:562
std::ostream & operator<<(std::ostream &o, const Attribute &attr)
Output a textual representation of the given Xml::Attribute to an std::ostream.
Definition: Xml.h:636
Attribute & setValue(const String &value)
If this is a valid attribute handle, change its value to the given String which should not be quoted.
bool isOrphan() const
Return true if this Attribute is an orphan, meaning that it is not empty, but is not owned by any ele...
This class provides a minimalist capability for reading and writing XML documents,...
Definition: Xml.h:307
Document(const String &pathname)
Create a new XML document and initialize it from the contents of the given file name.
void clear()
Restore this document to its default-constructed state.
String getXmlVersion() const
Returns the Xml "version" attribute as a string (from the declaration line at the beginning of the do...
void setXmlVersion(const String &version)
Set the Xml "version" attribute; this will be written to the "declaration" line which is first in any...
void insertTopLevelNodeBefore(const node_iterator &beforeThis, Node insertThis)
Insert a top-level Comment or Unknown node just before the location indicated by the node_iterator.
void readFromFile(const String &pathname)
Read the contents of this Xml::Document from the file whose pathname is supplied.
void eraseTopLevelNode(const node_iterator &deleteThis)
Delete the indicated top-level node, which must not be the root element, and must not be node_end().
void insertTopLevelNodeAfter(const node_iterator &afterThis, Node insertThis)
Insert a top-level Comment or Unknown node just after the location indicated by the node_iterator,...
static void setXmlCondenseWhiteSpace(bool shouldCondense)
Set global mode to control whether white space is preserved or condensed down to a single space (affe...
bool getXmlIsStandalone() const
Returns the Xml "standalone" attribute as a bool (from the declaration line at the beginning of the d...
void readFromString(const char *xmlDocument)
Alternate form that reads from a null-terminated C string (char*) rather than a C++ string object.
Document(const Document &source)
Copy constructor makes a deep copy of the entire source document; nothing is shared between the sourc...
void readFromString(const String &xmlDocument)
Read the contents of this Xml::Document from the supplied string.
void setIndentString(const String &indent)
Set the string to be used for indentation when we produce a "pretty-printed" serialized form of this ...
Element getRootElement()
Return an Element handle referencing the top-level element in this Xml::Document, known as the "root ...
Document()
Create an empty XML Document with default declaration and default root element with tag "_Root".
Document & operator=(const Document &souce)
Copy assignment frees all heap space associated with the current Xml::Document and then makes a deep ...
void writeToString(String &xmlDocument, bool compact=false) const
Write the contents of this in-memory Xml::Document to the supplied string.
node_iterator node_end() const
This node_end() iterator indicates the end of a sequence of nodes regardless of the NodeType restrict...
void writeToFile(const String &pathname) const
Write the contents of this in-memory Xml::Document to the file whose pathname is supplied.
void setRootTag(const String &tag)
Shortcut for changing the tag word of the root element which is usually the document type.
String getXmlEncoding() const
Returns the Xml "encoding" attribute as a string (from the declaration line at the beginning of the d...
const String & getRootTag() const
Shortcut for getting the tag word of the root element which is usually the document type.
std::ostream & operator<<(std::ostream &o, const Document &doc)
Output a "pretty printed" textual representation of the given Xml::Document to an std::ostream,...
Definition: Xml.h:531
node_iterator node_begin(NodeType allowed=AnyNodes)
Obtain an iterator to all the top-level nodes or a subset restricted via the allowed NodeType mask.
const String & getIndentString() const
Return the current value of the indent string. The default is four spaces.
static bool isXmlWhiteSpaceCondensed()
Return the current setting of the global "condense white space" option.
void setXmlEncoding(const String &encoding)
Set the Xml "encoding" attribute; this doesn't affect the in-memory representation but can affect how...
~Document()
The destructor cleans up all heap space associated with this document.
void setXmlIsStandalone(bool isStandalone)
Set the Xml "standalone" attribute; this is normally true (corresponding to standalone="yes") and won...
Node removeTopLevelNode(const node_iterator &removeThis)
Remove the indicated top-level node from the document, returning it as an orphan rather than erasing ...
An element has (1) a tagword, (2) a map of (name,value) pairs called attributes, and (3) a list of ch...
Definition: Xml.h:1033
void eraseAttribute(const String &name)
Erase an attribute of this element if it exists, otherwise do nothing.
void setValueAs(const T &value)
Set the value of this value element to the text equivalent of any type T for which a conversion const...
Definition: Xml.h:1158
auto fromXmlElementHelper(T &thing, Xml::Element &elt, const std::string &requiredTag, bool) -> decltype(std::declval< T >().fromXmlElement(elt, requiredTag))
Helper function for fromXmlElement() that selects the member function if it exists.
Definition: Xml.h:1688
T getOptionalElementValueAs(const String &tag, const T &def) const
Convert the text value of an optional child value element, if present, to the type of the template ar...
Definition: Xml.h:1219
T getRequiredElementValueAs(const String &tag) const
Convert the text value of a required child value element to the type of the template argument T.
Definition: Xml.h:1203
auto toXmlElementHelper(const T &thing, const std::string &name, bool) -> decltype(std::declval< T >().toXmlElement(name))
Helper function for toXmlElement() that selects the member function if it exists.
Definition: Xml.h:1632
Array_< Element > getAllElements(const String &tag="")
Return an array containing Element handles referencing all the immediate child elements contained in ...
Definition: Xml.h:1354
String getOptionalAttributeValue(const String &name, const String &def="") const
Get the value of an attribute as a string if the attribute is present in this element,...
Definition: Xml.h:1267
Element getRequiredElement(const String &tag)
Get a reference to a child element that must be present in this element.
void appendNode(Node node)
This is an abbreviation for insertNodeAfter(node_end(), node);.
Definition: Xml.h:1096
void getValueAs(T &out) const
Alternate form of getValueAs() that avoids unnecessary copying and heap allocation for reading in lar...
Definition: Xml.h:1172
attribute_iterator attribute_begin()
For iterating through all the attributes of this element.
String & updValue()
Obtain a writable reference to the String containing the value of this value element.
Element getOptionalElement(const String &tag)
Get a reference to a child element that may be present in this element; otherwise return an invalid E...
bool isValueElement() const
Determine whether this element qualifies as a "value element", defined as an element containing zero ...
const String & getElementTag() const
Get the element tag word.
void insertNodeBefore(const node_iterator &pos, Node node)
Insert a node into the list of this Element's children, just before the node pointed to by the suppli...
Array_< Node > getAllNodes(NodeType allowed=AnyNodes)
Return an array containing Node handles referencing all the immediate child nodes contained in this e...
Definition: Xml.h:1363
const String & getRequiredElementValue(const String &tag) const
Get the text value of a child value element that must be present in this element.
Definition: Xml.h:1183
static bool isA(const Node &)
Test whether a given Node is an element node.
attribute_iterator attribute_end() const
This attribute_end() iterator indicates the end of a sequence of attributes.
void setElementTag(const String &tag)
Change the tag word that is used to bracket this element.
node_iterator node_end() const
This node_end() iterator indicates the end of any sequence of nodes regardless of the NodeType restri...
Array_< Attribute > getAllAttributes()
Return an array containing Attribute handles referencing all the attributes of this element.
Definition: Xml.h:1305
element_iterator element_end() const
This element_end() iterator indicates the end of any sequence of elements regardless of the tag restr...
bool hasElement(const String &tag) const
Return true if this element has a child element with this tag.
Element clone() const
The clone() method makes a deep copy of this Element and its children and returns a new orphan Elemen...
void setValue(const String &value)
Set the text value of this value element.
void setAttributeValue(const String &name, const String &value)
Set the value of an attribute of this element, creating a new one if this is a new attribute name oth...
element_iterator element_begin(const String &tag="")
For iterating through the immediate child elements of this element, or the child elements that have t...
T getOptionalAttributeValueAs(const String &name, const T &def) const
Convert the value of an optional attribute, if present, from a string to the type of the template arg...
Definition: Xml.h:1283
void insertNodeAfter(const node_iterator &pos, Node node)
Insert a node into the list of this Element's children, just after the node pointed to by the supplie...
auto toXmlElementHelper(const T &thing, const std::string &name, int) -> Xml::Element
Helper function for toXmlElement() that selects the free function if no member function exists.
Definition: Xml.h:1641
node_iterator node_begin(NodeType allowed=AnyNodes)
For iterating through the immediate child nodes of this element, or the child nodes of the type(s) al...
Xml::Element toXmlElement(const T &thing, const std::string &name)
Default implementation of serialization to an XML element for objects whose class does not define a m...
Definition: Xml.h:1622
T getValueAs() const
Assuming this is a "value element", convert its text value to the type of the template argument T.
Definition: Xml.h:1167
Attribute getOptionalAttribute(const String &name)
Obtain an Attribute handle referencing a particular attribute of this element specified by name,...
auto fromXmlElementHelper(T &thing, Xml::Element &elt, const std::string &requiredTag, int) -> void
Helper function for fromXmlElement() that selects the free function if no member function exists.
Definition: Xml.h:1698
Element(const String &tagWord, const String &value="")
Create a value element that uses the given tag word but is not yet part of any XML document,...
bool hasAttribute(const String &name) const
Return true if this element has an attribute of this name.
void eraseNode(const node_iterator &deleteThis)
Delete the indicated node, which must be a child of this element, and must not be node_end().
T getRequiredAttributeValueAs(const String &name) const
Convert the text value of a required attribute to the type of the template argument T.
Definition: Xml.h:1257
Element()
Create an empty Element handle; this is suitable only for holding references to other Elements.
Definition: Xml.h:1046
const String & getValue() const
Get the text value of this value element.
Attribute getRequiredAttribute(const String &name)
Obtain an Attribute handle referencing a particular attribute of this element; an error will be throw...
static Element & getAs(Node &node)
Recast a writable Node to a writable Element, throwing an error if the Node is not actually an elemen...
void fromXmlElement(T &thing, Xml::Element &elt, const std::string &requiredName="")
Default implementation of deserialization from an XML element for objects whose class does not define...
Definition: Xml.h:1668
Element(const String &tagWord, const T &value)
Create a new value element and set its initial value to the text equivalent of any type T for which a...
Definition: Xml.h:1068
String getOptionalElementValue(const String &tag, const String &def="") const
Get the text value of a child value element that may be present in this element, otherwise return a d...
Definition: Xml.h:1190
static const Element & getAs(const Node &node)
Recast a Node to a const Element, throwing an error if the Node is not actually an element node.
bool hasNode(NodeType allowed=AnyNodes) const
See if this element has any child nodes, or any child nodes of the type(s) allowed by the NodeType fi...
const String & getRequiredAttributeValue(const String &name) const
Get the value of an attribute as a string and throw an error if that attribute is not present.
Definition: Xml.h:1247
Node removeNode(const node_iterator &removeThis)
Remove the indicated node from this element without erasing it, returning it as an orphan Node.
Abstract handle for holding any kind of node in an XML tree.
Definition: Xml.h:742
bool isTopLevelNode() const
Return true if this Node is owned by the top-level Xml document, false if the Node is owned by an Ele...
bool isValid() const
Return true if this Node handle is referencing some node, false if the Node handle is empty.
Definition: Xml.h:796
Node(const Node &src)
Copy constructor is shallow; that is, this handle will refer to the same node as the source.
Definition: Xml.h:756
NodeType getNodeType() const
Get the Xml::NodeType of this node.
String getNodeTypeAsString() const
Get the Node type as a string; an empty handle returns "NoNode".
Node()
Create an empty Node handle that can be used to hold a reference to any kind of Node.
Definition: Xml.h:752
const String & getNodeText() const
Return a text value associated with this Node (not including its child nodes if any); the behavior de...
Node clone() const
The clone() method makes a deep copy of this Node and its children and returns a new orphan Node with...
std::ostream & operator<<(std::ostream &o, const Node &xmlNode)
Output a "pretty printed" textual representation of the given XML node (and all its contents) to an s...
Definition: Xml.h:890
bool isOrphan() const
Return true if this Node is an orphan, meaning that it is not empty, but is not owned by any element ...
Element getParentElement()
Return a handle referencing this node's parent if it has one, otherwise throws an error; check first ...
void writeToString(String &out, bool compact=false) const
Serialize this node (and everything it contains) to the given String.
void clear()
This method restores the Node handle to its default-constructed state but does not recover any heap s...
Node & operator=(const Node &src)
Copy assignment is shallow; the handle is first cleared and then will refer to the same node as the s...
Definition: Xml.h:761
bool operator==(const Node &other) const
Comparing Nodes for equality means asking if the two Node handles are referring to exactly the same o...
Definition: Xml.h:849
bool operator!=(const Node &other) const
Inequality test using same criteria as operator==().
Definition: Xml.h:851
~Node()
The Node handle destructor does not recover heap space so if you create orphan nodes and then don't p...
Definition: Xml.h:770
void clearOrphan()
This method explicitly frees the heap space for an orphan node that was created but never inserted in...
bool hasParentElement() const
Return true if this node has a parent, i.e.
This is the "leaf" content of an element.
Definition: Xml.h:1447
static bool isA(const Node &)
Test whether a given Node is an Text node.
static Text & getAs(Node &node)
Recast a writable Node to a writable Text node, throwing an error if the Node is not actually a Text ...
static const Text & getAs(const Node &node)
Recast a Node to a const Text node, throwing an error if the Node is not actually a Text node.
const String & getText() const
Obtain a const reference to the String holding the value of this Text.
Text clone() const
The clone() method makes a deep copy of this Text node and returns a new orphan Text node with the sa...
Text(const String &text)
Create a new Text node with the given text; the node is not yet owned by any XML document.
String & updText()
Obtain a writable reference to the String holding the value of this Text node; this can be used to al...
Text()
Create an empty Text node handle, suitable only for holding references to other Text nodes.
Definition: Xml.h:1451
This is something we don't understand but can carry around.
Definition: Xml.h:1542
const String & getContents() const
Obtain the contents of this Unknown node.
void setContents(const String &contents)
Change the contents of this Unknown node.
static bool isA(const Node &)
Test whether a given Node is an Unknown node.
Unknown(const String &contents)
Create a new Unknown node with the given contents; the node is not yet owned by any XML document.
static const Unknown & getAs(const Node &node)
Recast a Node to a const Unknown, throwing an error if the Node is not actually an Unknown node.
Unknown(Element &element, const String &contents)
Create a new Unknown node and append it to the list of nodes that are children of the given Element.
Definition: Xml.h:1558
Unknown()
Create an empty Unknown node handle, suitable only for holding references to other Unknown nodes.
Definition: Xml.h:1546
static Unknown & getAs(Node &node)
Recast a writable Node to a writable Unknown, throwing an error if the Node is not actually an Unknow...
Unknown clone() const
The clone() method makes a deep copy of this Unknown node and returns a new orphan Unknown node with ...
This is a bidirectional iterator suitable for moving forward or backward within a list of Attributes ...
Definition: Xml.h:650
Attribute & operator*() const
Return a writable reference to the Attribute referenced by this iterator; the handle will be invalid ...
Definition: Xml.h:690
attribute_iterator(Attribute &attr)
Construct this iterator to point to the same attribute as does the supplied Attribute handle (or attr...
Definition: Xml.h:657
Attribute * operator->() const
Return a writable pointer to the Attribute referenced by this iterator; the pointer will never be nul...
Definition: Xml.h:694
~attribute_iterator()
An iterator destructor never deletes the object to which it refers.
Definition: Xml.h:663
attribute_iterator & operator--()
Prefix decrement operator moves the iterator to the previous attribute (or attribute_end() if it was ...
attribute_iterator & operator++()
Prefix increment operator advances the iterator to the next attribute (or attribute_end() if it was a...
attribute_iterator()
Default constructor creates an iterator that compares equal to attribute_end().
Definition: Xml.h:654
attribute_iterator operator--(int)
Postfix decrement operator moves the iterator to the previous attribute (or attribute_end() if it was...
bool operator!=(const attribute_iterator &other) const
Uses same criteria as operator==().
Definition: Xml.h:702
bool operator==(const attribute_iterator &other) const
Comparison return true only if both iterators refer to the same in-memory attribute or both are at at...
Definition: Xml.h:699
attribute_iterator operator++(int)
Postfix increment operator advances the iterator to the next attribute (or attribute_end() if it was ...
attribute_iterator & operator=(const attribute_iterator &src)
Copy assignment takes an attribute_iterator that can be const, but that still allows writing to the A...
Definition: Xml.h:666
attribute_iterator(const attribute_iterator &src)
Copy constructor takes an attribute_iterator that can be const, but that still allows writing to the ...
Definition: Xml.h:660
This is a bidirectional iterator suitable for moving forward or backward within a list of Element nod...
Definition: Xml.h:964
element_iterator & operator--()
element_iterator & operator=(const element_iterator &src)
Copy assignment takes an element_iterator that can be const, but that still allows writing to the Ele...
Definition: Xml.h:982
element_iterator operator--(int)
Element * operator->() const
Definition: Xml.h:1437
element_iterator & operator++()
bool operator!=(const element_iterator &other) const
Definition: Xml.h:994
Element & operator*() const
Definition: Xml.h:1435
element_iterator operator++(int)
element_iterator(const element_iterator &src)
Copy constructor takes an element_iterator that can be const, but that still allows writing to the El...
Definition: Xml.h:977
bool operator==(const element_iterator &other) const
Definition: Xml.h:992
element_iterator(const String &tag="")
This is the default constructor which leaves the element_iterator empty, and you can optionally set t...
Definition: Xml.h:969
This is a bidirectional iterator suitable for moving forward or backward within a list of Nodes,...
Definition: Xml.h:905
void reassign(TiXmlNode *tiNode)
Definition: Xml.h:941
node_iterator(Node &node, NodeType allowed=AnyNodes)
Definition: Xml.h:910
bool operator!=(const node_iterator &other) const
Definition: Xml.h:935
node_iterator operator++(int)
node_iterator(const node_iterator &src)
Copy constructor takes a node_iterator that can be const, but that still allows writing to the Node.
Definition: Xml.h:915
Node & operator*()
Definition: Xml.h:928
node_iterator & operator=(const node_iterator &src)
Copy assignment takes an node_iterator that can be const, but that still allows writing to the Node.
Definition: Xml.h:921
node_iterator & operator++()
node_iterator & operator--()
node_iterator(TiXmlNode *tiNode, NodeType allowed=AnyNodes)
Definition: Xml.h:939
node_iterator(NodeType allowed=AnyNodes)
Definition: Xml.h:908
Node & operator*() const
Definition: Xml.h:932
bool operator==(const node_iterator &other) const
Definition: Xml.h:934
~node_iterator()
An iterator destructor never deletes the object to which it refers.
Definition: Xml.h:918
node_iterator operator--(int)
Node * operator->()
Definition: Xml.h:929
friend class element_iterator
Definition: Xml.h:949
Node * operator->() const
Definition: Xml.h:933
bool readUnformatted(std::istream &in, T &v)
The default implementation of readUnformatted<T> reads in the next whitespace-separated token and the...
Definition: Serialize.h:176
NodeType
The Xml::NodeType enum serves as the actual type of a node and as a filter for allowable node types d...
Definition: Xml.h:72
@ NoNode
Type of empty Node handle, or null filter.
Definition: Xml.h:73
@ JunkNodes
Filter out meaningful nodes.
Definition: Xml.h:80
@ AnyNodes
Allow all nodes.
Definition: Xml.h:81
@ NoJunkNodes
Filter out meaningless nodes.
Definition: Xml.h:79
@ ElementNode
Element node type and only-Elements filter.
Definition: Xml.h:74
@ UnknownNode
Unknown node type and only-Unknowns filter.
Definition: Xml.h:77
@ CommentNode
Comment node type and only-Comments filter.
Definition: Xml.h:76
@ TextNode
Text node type and only-Text nodes filter.
Definition: Xml.h:75
String getNodeTypeAsString(NodeType type)
Translate a NodeType to a human-readable string.
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
Matrix_< E > operator*(const MatrixBase< E > &l, const typename CNT< E >::StdNumber &r)
Definition: BigMatrix.h:605
Obtain human-readable and XML-usable names for arbitrarily-complicated C++ types.
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:858