Inheritance diagram for OpenSim::XMLDocument:

Public Member Functions
virtual	~XMLDocument ()

	XMLDocument ()

	XMLDocument (const std::string &aFileName)

	XMLDocument (const XMLDocument &aDocument)

void	copyDefaultObjects (const XMLDocument &aDocument)

void	writeDefaultObjects (SimTK::Xml::Element &elmt)

const int &	getDocumentVersion () const

SimTK::Xml::Element	getRootDataElement ()

bool	isEqualTo (XMLDocument &aOtherDocument, double toleranceForDoubles=1e-6, bool compareDefaults=false, bool compareVersionNumbers=false)

void	setFileName (const std::string &aFileName)

const std::string &	getFileName () const

void	addDefaultObject (OpenSim::Object *aDefaultObject)

bool	hasDefaultObjects () const

bool	print (const std::string &aFileName=NULL)

Public Member Functions inherited from SimTK::Xml::Document
	Document ()

	Document (const String &pathname)

	Document (const Document &source)

Document &	operator= (const Document &souce)

	~Document ()

void	clear ()

Element	getRootElement ()

const String &	getRootTag () const

void	setRootTag (const String &tag)

void	insertTopLevelNodeAfter (const node_iterator &afterThis, Node insertThis)

void	insertTopLevelNodeBefore (const node_iterator &beforeThis, Node insertThis)

void	eraseTopLevelNode (const node_iterator &deleteThis)

Node	removeTopLevelNode (const node_iterator &removeThis)

node_iterator	node_begin (NodeType allowed=AnyNodes)

node_iterator	node_end () const

String	getXmlVersion () const

String	getXmlEncoding () const

bool	getXmlIsStandalone () const

void	setXmlVersion (const String &version)

void	setXmlEncoding (const String &encoding)

void	setXmlIsStandalone (bool isStandalone)

std::ostream &	operator<< (std::ostream &o, const Document &doc)

	Document ()

	Document (const String &pathname)

	Document (const Document &source)

Document &	operator= (const Document &souce)

	~Document ()

void	clear ()

void	readFromFile (const String &pathname)

void	writeToFile (const String &pathname) const

void	readFromString (const String &xmlDocument)

void	readFromString (const char *xmlDocument)

void	writeToString (String &xmlDocument, bool compact=false) const

void	setIndentString (const String &indent)

const String &	getIndentString () const

Element	getRootElement ()

const String &	getRootTag () const

void	setRootTag (const String &tag)

void	insertTopLevelNodeAfter (const node_iterator &afterThis, Node insertThis)

void	insertTopLevelNodeBefore (const node_iterator &beforeThis, Node insertThis)

void	eraseTopLevelNode (const node_iterator &deleteThis)

Node	removeTopLevelNode (const node_iterator &removeThis)

node_iterator	node_begin (NodeType allowed=AnyNodes)

node_iterator	node_end () const

String	getXmlVersion () const

String	getXmlEncoding () const

bool	getXmlIsStandalone () const

void	setXmlVersion (const String &version)

void	setXmlEncoding (const String &encoding)

void	setXmlIsStandalone (bool isStandalone)

Static Public Member Functions
static const int &	getLatestVersion ()

static void	renameChildNode (SimTK::Xml::Element &aNode, std::string oldElementName, std::string newElementName)

static void	getVersionAsString (const int aVersion, std::string &aString)

static void	addConnector (SimTK::Xml::Element &element, const std::string &connectorTag, const std::string &connectorName, const std::string &connectorValue)
	This adds an XML element to `element` of the following form: More...

static void	updateConnectors30508 (SimTK::Xml::Element &componentElt)
	In version 30508, the XML syntax for Connectors changed: Previous: More...

static void	addPhysicalOffsetFrame30505_30517 (SimTK::Xml::Element &element, const std::string &frameName, const std::string &parentFrameName, const SimTK::Vec3 &location, const SimTK::Vec3 &orientation)

static std::string	updateConnecteePath30517 (const std::string &connecteeSetName, const std::string &connecteeName)
	Convert component names into the appropriate paths based on where we know components were located in version 30000 model files. More...

static SimTK::Xml::Element	findElementWithName (SimTK::Xml::Element &element, const std::string &name)
	Find the first XML Element (depth-first search) with the provided `name`, anywhere in the XML document that contains `element`. More...

Static Public Member Functions inherited from SimTK::Xml::Document
static void	setXmlCondenseWhiteSpace (bool shouldCondense)

static bool	isXmlWhiteSpaceCondensed ()

Static Public Attributes
static const int	LatestVersion
	Latest version of the code encoded as an int xxyyzz where x: major release, y: minor, z: patch. More...

Constructor & Destructor Documentation

◆ ~XMLDocument()

virtual OpenSim::XMLDocument::~XMLDocument ( )

virtual

◆ XMLDocument() [1/3]

OpenSim::XMLDocument::XMLDocument ( )

◆ XMLDocument() [2/3]

OpenSim::XMLDocument::XMLDocument ( const std::string & aFileName )

◆ XMLDocument() [3/3]

OpenSim::XMLDocument::XMLDocument ( const XMLDocument & aDocument )

Member Function Documentation

◆ addConnector()

static void OpenSim::XMLDocument::addConnector	(	SimTK::Xml::Element &	element,
		const std::string &	connectorTag,
		const std::string &	connectorName,
		const std::string &	connectorValue
	)

static

This adds an XML element to element of the following form:

<Connector_PhysicalFrame_ name="parent_frame">
    <connectee_name>...</connectee_name>
</Connector_PhysicalFrame_>

This syntax was revised in XML document version 30508; see updateConnectors30508(). As such, this function should not be used for updating versions 30508 or greater.

◆ addDefaultObject()

void OpenSim::XMLDocument::addDefaultObject ( OpenSim::Object * aDefaultObject )

◆ addPhysicalOffsetFrame30505_30517()

static void OpenSim::XMLDocument::addPhysicalOffsetFrame30505_30517	(	SimTK::Xml::Element &	element,
		const std::string &	frameName,
		const std::string &	parentFrameName,
		const SimTK::Vec3 &	location,
		const SimTK::Vec3 &	orientation
	)

static

◆ copyDefaultObjects()

void OpenSim::XMLDocument::copyDefaultObjects ( const XMLDocument & aDocument )

◆ findElementWithName()

static SimTK::Xml::Element OpenSim::XMLDocument::findElementWithName	(	SimTK::Xml::Element &	element,
		const std::string &	name
	)

static

Find the first XML Element (depth-first search) with the provided name, anywhere in the XML document that contains element.

If the XML document does not contain an element with name name, or if name is empty, then the returned Xml::Element is empty (Xml::Element::isValid() returns false).

◆ getDocumentVersion()

const int& OpenSim::XMLDocument::getDocumentVersion ( ) const

inline

◆ getFileName()

const std::string& OpenSim::XMLDocument::getFileName ( ) const

◆ getLatestVersion()

static const int& OpenSim::XMLDocument::getLatestVersion ( )

inlinestatic

Referenced by OpenSim::Appearance::updateFromXMLNode().

◆ getRootDataElement()

SimTK::Xml::Element OpenSim::XMLDocument::getRootDataElement ( )

◆ getVersionAsString()

static void OpenSim::XMLDocument::getVersionAsString	(	const int	aVersion,
		std::string &	aString
	)

static

◆ hasDefaultObjects()

bool OpenSim::XMLDocument::hasDefaultObjects ( ) const

inline

References OpenSim::Array< T >::getSize().

◆ isEqualTo()

bool OpenSim::XMLDocument::isEqualTo	(	XMLDocument &	aOtherDocument,
		double	toleranceForDoubles = `1e-6`,
		bool	compareDefaults = `false`,
		bool	compareVersionNumbers = `false`
	)

◆ print()

bool OpenSim::XMLDocument::print ( const std::string & aFileName = NULL )

◆ renameChildNode()

static void OpenSim::XMLDocument::renameChildNode	(	SimTK::Xml::Element &	aNode,
		std::string	oldElementName,
		std::string	newElementName
	)

static

◆ setFileName()

void OpenSim::XMLDocument::setFileName ( const std::string & aFileName )

◆ updateConnecteePath30517()

static std::string OpenSim::XMLDocument::updateConnecteePath30517	(	const std::string &	connecteeSetName,
		const std::string &	connecteeName
	)

static

Convert component names into the appropriate paths based on where we know components were located in version 30000 model files.

Parameters

depth	What's the tree depth of the component containing the relevant socket?
connecteeSetName	"bodyset", "jointset", etc.
connecteeName	The name of the connectee from the version 30000 file. Note: It is okay for connecteePath to be a reference to connecteeName.

◆ updateConnectors30508()

static void OpenSim::XMLDocument::updateConnectors30508 ( SimTK::Xml::Element & componentElt )

static

In version 30508, the XML syntax for Connectors changed: Previous:

<connectors>
    <Connector_PhysicalFrame_ name="parent_frame">
        <connectee_name>...</connectee_name>
    </Connector_PhysicalFrame_>
    <Connector_PhysicalFrame_ name="child_frame">
        <connectee_name>...</connectee_name>
    </Connector_PhysicalFrame_>
</connectors>

New:

<connector_parent_frame_connectee_name>...
    </connector_parent_frame_connectee_name>
<connector_child_frame_connectee_name>...
    </connector_child_frame_connectee_name>

If there is no <connectors> element, then this function does not edit componentElt.

◆ writeDefaultObjects()

void OpenSim::XMLDocument::writeDefaultObjects ( SimTK::Xml::Element & elmt )

Member Data Documentation

◆ LatestVersion

const int OpenSim::XMLDocument::LatestVersion

static

Latest version of the code encoded as an int xxyyzz where x: major release, y: minor, z: patch.

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

OpenSim/Common/XMLDocument.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ ~XMLDocument()

◆ XMLDocument() [1/3]

◆ XMLDocument() [2/3]

◆ XMLDocument() [3/3]

Member Function Documentation

◆ addConnector()

◆ addDefaultObject()

◆ addPhysicalOffsetFrame30505_30517()

◆ copyDefaultObjects()

◆ findElementWithName()

◆ getDocumentVersion()

◆ getFileName()

◆ getLatestVersion()

◆ getRootDataElement()

◆ getVersionAsString()

◆ hasDefaultObjects()

◆ isEqualTo()

◆ print()

◆ renameChildNode()

◆ setFileName()

◆ updateConnecteePath30517()

◆ updateConnectors30508()

◆ writeDefaultObjects()

Member Data Documentation

◆ LatestVersion