XmlObjMgt Class Reference

This package defines services to manage the storage grain of data produced by applications and those classes to manage persistent extern reference. More...

#include <XmlObjMgt.hxx>

Static Public Member Functions
static const XmlObjMgt_DOMString &	IdString ()
	Define the name of XMLattribute 'ID' (to be used everywhere)
static Standard_Boolean	SetExtendedString (XmlObjMgt_Element &theElement, const TCollection_ExtendedString &theString)
	Add attribute <theElement extstring="theString" ...>
static Standard_Boolean	GetExtendedString (const XmlObjMgt_Element &theElement, TCollection_ExtendedString &theString)
	Get attribute <theElement extstring="theString" ...>
static XmlObjMgt_DOMString	GetStringValue (const XmlObjMgt_Element &theElement)
	Returns the first child text node.
static void	SetStringValue (XmlObjMgt_Element &theElement, const XmlObjMgt_DOMString &theData, const Standard_Boolean isClearText=Standard_False)
	Add theData as the last child text node to theElement isClearText(True) avoids analysis of the string and replacement of characters like '<' and '&' during XML file storage. Do NEVER set isClearText unless you have a hell of a reason.
static Standard_Boolean	GetTagEntryString (const XmlObjMgt_DOMString &theTarget, TCollection_AsciiString &theTagEntry)
	Convert XPath expression (DOMString) into TagEntry string returns False on Error.
static void	SetTagEntryString (XmlObjMgt_DOMString &theSource, const TCollection_AsciiString &theTagEntry)
	Convert XPath expression (DOMString) into TagEntry string returns False on Error.
static XmlObjMgt_Element	FindChildElement (const XmlObjMgt_Element &theSource, const Standard_Integer theObjId)
static XmlObjMgt_Element	FindChildByRef (const XmlObjMgt_Element &theSource, const XmlObjMgt_DOMString &theRefName)
static XmlObjMgt_Element	FindChildByName (const XmlObjMgt_Element &theSource, const XmlObjMgt_DOMString &theName)
static Standard_Boolean	GetInteger (Standard_CString &theString, Standard_Integer &theValue)
static Standard_Boolean	GetReal (Standard_CString &theString, Standard_Real &theValue)
static Standard_Boolean	GetReal (const XmlObjMgt_DOMString &theString, Standard_Real &theValue)

Detailed Description

This package defines services to manage the storage grain of data produced by applications and those classes to manage persistent extern reference.

Member Function Documentation

FindChildByName()

static XmlObjMgt_Element XmlObjMgt::FindChildByName ( const XmlObjMgt_Element & theSource, const XmlObjMgt_DOMString & theName )

static

FindChildByRef()

static XmlObjMgt_Element XmlObjMgt::FindChildByRef ( const XmlObjMgt_Element & theSource, const XmlObjMgt_DOMString & theRefName )

static

FindChildElement()

static XmlObjMgt_Element XmlObjMgt::FindChildElement ( const XmlObjMgt_Element & theSource, const Standard_Integer theObjId )

static

GetExtendedString()

static Standard_Boolean XmlObjMgt::GetExtendedString ( const XmlObjMgt_Element & theElement, TCollection_ExtendedString & theString )

static

Get attribute <theElement extstring="theString" ...>

GetInteger()

static Standard_Boolean XmlObjMgt::GetInteger ( Standard_CString & theString, Standard_Integer & theValue )

static

GetReal() [1/2]

static Standard_Boolean XmlObjMgt::GetReal ( const XmlObjMgt_DOMString & theString, Standard_Real & theValue )

static

GetReal() [2/2]

static Standard_Boolean XmlObjMgt::GetReal ( Standard_CString & theString, Standard_Real & theValue )

static

GetStringValue()

static XmlObjMgt_DOMString XmlObjMgt::GetStringValue ( const XmlObjMgt_Element & theElement )

static

Returns the first child text node.

GetTagEntryString()

static Standard_Boolean XmlObjMgt::GetTagEntryString ( const XmlObjMgt_DOMString & theTarget, TCollection_AsciiString & theTagEntry )

static

Convert XPath expression (DOMString) into TagEntry string returns False on Error.

IdString()

static const XmlObjMgt_DOMString & XmlObjMgt::IdString ( )

static

Define the name of XMLattribute 'ID' (to be used everywhere)

SetExtendedString()

static Standard_Boolean XmlObjMgt::SetExtendedString ( XmlObjMgt_Element & theElement, const TCollection_ExtendedString & theString )

static

Add attribute <theElement extstring="theString" ...>

SetStringValue()

static void XmlObjMgt::SetStringValue ( XmlObjMgt_Element & theElement, const XmlObjMgt_DOMString & theData, const Standard_Boolean isClearText = Standard_False )

static

Add theData as the last child text node to theElement isClearText(True) avoids analysis of the string and replacement of characters like '<' and '&' during XML file storage. Do NEVER set isClearText unless you have a hell of a reason.

SetTagEntryString()

static void XmlObjMgt::SetTagEntryString ( XmlObjMgt_DOMString & theSource, const TCollection_AsciiString & theTagEntry )

static

Convert XPath expression (DOMString) into TagEntry string returns False on Error.

---

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

• XmlObjMgt.hxx