Simbody  3.6
SimTK::Xml Namespace Reference

This namespace contains Xml::Document and all the related XML classes. More...

Classes

class  Attribute
 Elements can have attributes, which are name="value" pairs that appear within the element start tag in an XML document; this class represents the in-memory representation of one of those attributes and can be used to examine or modify the name or value. More...
 
class  attribute_iterator
 This is a bidirectional iterator suitable for moving forward or backward within a list of Attributes within an Element, for writable access. More...
 
class  Comment
 A comment contains only uninterpreted text. More...
 
class  Document
 This class provides a minimalist capability for reading and writing XML documents, as files or strings. More...
 
class  Element
 An element has (1) a tagword, (2) a map of (name,value) pairs called attributes, and (3) a list of child nodes. More...
 
class  element_iterator
 This is a bidirectional iterator suitable for moving forward or backward within a list of Element nodes, for writable access. More...
 
class  Node
 Abstract handle for holding any kind of node in an XML tree. More...
 
class  node_iterator
 This is a bidirectional iterator suitable for moving forward or backward within a list of Nodes, for writable access. More...
 
class  Text
 This is the "leaf" content of an element. More...
 
class  Unknown
 This is something we don't understand but can carry around. More...
 

Enumerations

enum  NodeType {
  NoNode = 0x00,
  ElementNode = 0x01,
  TextNode = 0x02,
  CommentNode = 0x04,
  UnknownNode = 0x08,
  NoJunkNodes = ElementNode|TextNode,
  JunkNodes = CommentNode|UnknownNode,
  AnyNodes = NoJunkNodes|JunkNodes
}
 The Xml::NodeType enum serves as the actual type of a node and as a filter for allowable node types during an iteration over nodes. More...
 

Functions

String getNodeTypeAsString (NodeType type)
 Translate a NodeType to a human-readable string. More...
 

Detailed Description

This namespace contains Xml::Document and all the related XML classes.

Enumeration Type Documentation

◆ NodeType

The Xml::NodeType enum serves as the actual type of a node and as a filter for allowable node types during an iteration over nodes.

We consider Element and Text nodes to be meaningful, while Comment and Unknown nodes are meaningless junk. However, you are free to extract some meaning from them if you know how. In particular, DTD nodes end up as Unknown.

Enumerator
NoNode 

Type of empty Node handle, or null filter.

ElementNode 

Element node type and only-Elements filter.

TextNode 

Text node type and only-Text nodes filter.

CommentNode 

Comment node type and only-Comments filter.

UnknownNode 

Unknown node type and only-Unknowns filter.

NoJunkNodes 

Filter out meaningless nodes.

JunkNodes 

Filter out meaningful nodes.

AnyNodes 

Allow all nodes.

Function Documentation

◆ getNodeTypeAsString()

String SimTK::Xml::getNodeTypeAsString ( NodeType  type)

Translate a NodeType to a human-readable string.