OCC.Core.XmlObjMgt module

XmlObjMgt module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_xmlobjmgt.html

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class XmlObjMgt_Array1(*args)

Bases: object

• Create an array of lower bound <Low> and upper bound <Up>. Range error is raised when <Up> is less than <Low>.

  param Low

  type Low

  int

  param Up

  type Up

  int

  rtype

  None* for restoration from DOM_Element which is child of theParent: <theParent …> <theName …>

  param theParent

  type theParent

  XmlObjMgt_Element &

  param theName

  type theName

  XmlObjMgt_DOMString &

  rtype

  None

CreateArrayElement()

• Create DOM_Element representing the array, under ‘theParent’

  param theParent

  type theParent

  XmlObjMgt_Element &

  param theName

  type theName

  XmlObjMgt_DOMString &

  rtype

  None

Element()

• Returns the DOM element of <self>.

  rtype

  XmlObjMgt_Element

Length()

• Returns the number of elements of <self>.

  rtype

  int

Lower()

• Returns the lower bound.

  rtype

  int

SetValue()

• Set the <Index>th element of the array to <Value>.

  param Index

  type Index

  int

  param Value

  type Value

  XmlObjMgt_Element &

  rtype

  None

Upper()

• Returns the upper bound.

  rtype

  int

Value()

• Returns the value of <Index>th element of the array.

  param Index

  type Index

  int

  rtype

  XmlObjMgt_Element

property thisown

The membership flag

class XmlObjMgt_GP

Bases: object

static Translate()

Parameters

aTrsf –

type aTrsf

gp_Trsf

rtype

XmlObjMgt_DOMString:param aMat:

type aMat

gp_Mat

rtype

XmlObjMgt_DOMString:param anXYZ:

type anXYZ

gp_XYZ

rtype

XmlObjMgt_DOMString:param aStr:

type aStr

XmlObjMgt_DOMString &

param T

type T

gp_Trsf

rtype

bool:param aStr:

type aStr

XmlObjMgt_DOMString &

param T

type T

gp_Mat

rtype

bool:param aStr:

type aStr

XmlObjMgt_DOMString &

param T

type T

gp_XYZ

rtype

bool

property thisown

The membership flag

class XmlObjMgt_Persistent(*args)

Bases: object

• empty constructor

  rtype

  None* constructor

  param theElement

  type theElement

  XmlObjMgt_Element &

  rtype

  None* constructor from sub-element of Element referenced by theRef

  param theElement

  type theElement

  XmlObjMgt_Element &

  param theRef

  type theRef

  XmlObjMgt_DOMString &

  rtype

  None

CreateElement()

• myElement := <theType id=’theID’/>

  param theParent

  type theParent

  XmlObjMgt_Element &

  param theType

  type theType

  XmlObjMgt_DOMString &

  param theID

  type theID

  int

  rtype

  None

Element()

• return myElement

  rtype

  XmlObjMgt_Element

Id()

Return type

int

SetId()

Parameters

theId –

type theId

int

rtype

None

property thisown

The membership flag

class XmlObjMgt_RRelocationTable(*args, **kwargs)

Bases: OCC.Core.TColStd.TColStd_DataMapOfIntegerTransient

Clear()

Parameters

doReleaseMemory – default value is Standard_True :type doReleaseMemory: bool :rtype: None

GetHeaderData()

• Returns a handle to the header data of the file that is begin read

  rtype

  opencascade::handle<Storage_HeaderData>

SetHeaderData()

• Sets the storage header data. //! @param theHeaderData header data of the file that is begin read

  param theHeaderData

  type theHeaderData

  opencascade::handle<Storage_HeaderData> &

  rtype

  None

property thisown

The membership flag

class XmlObjMgt_SRelocationTable(*args, **kwargs)

Bases: OCC.Core.TColStd.TColStd_IndexedMapOfTransient

Clear()

Parameters

doReleaseMemory – default value is Standard_True :type doReleaseMemory: bool :rtype: None

GetHeaderData()

• Returns a handle to the header data of the file that is begin read

  rtype

  opencascade::handle<Storage_HeaderData>

SetHeaderData()

• Sets the storage header data. //! @param theHeaderData header data of the file that is begin read

  param theHeaderData

  type theHeaderData

  opencascade::handle<Storage_HeaderData> &

  rtype

  None

property thisown

The membership flag

class xmlobjmgt

Bases: object

static FindChildByName()

Parameters

theSource –

type theSource

XmlObjMgt_Element &

param theName

type theName

XmlObjMgt_DOMString &

rtype

XmlObjMgt_Element

static FindChildByRef()

Parameters

theSource –

type theSource

XmlObjMgt_Element &

param theRefName

type theRefName

XmlObjMgt_DOMString &

rtype

XmlObjMgt_Element

static FindChildElement()

Parameters

theSource –

type theSource

XmlObjMgt_Element &

param theObjId

type theObjId

int

rtype

XmlObjMgt_Element

static GetExtendedString()

• Get attribute <theElement extstring=’theString’ …>

  param theElement

  type theElement

  XmlObjMgt_Element &

  param theString

  type theString

  TCollection_ExtendedString &

  rtype

  bool

static GetInteger()

Parameters

theString –

type theString

char * &

param theValue

type theValue

int &

rtype

bool

static GetReal()

Parameters

theString –

type theString

char * &

param theValue

type theValue

float &

rtype

bool:param theString:

type theString

XmlObjMgt_DOMString &

param theValue

type theValue

float &

rtype

bool

static GetStringValue()

• Returns the first child text node

  param theElement

  type theElement

  XmlObjMgt_Element &

  rtype

  XmlObjMgt_DOMString

static GetTagEntryString()

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

  param theTarget

  type theTarget

  XmlObjMgt_DOMString &

  param theTagEntry

  type theTagEntry

  TCollection_AsciiString &

  rtype

  bool

static IdString()

• Define the name of XMLattribute ‘ID’ (to be used everywhere)

  rtype

  XmlObjMgt_DOMString

static SetExtendedString()

• Add attribute <theElement extstring=’theString’ …>

  param theElement

  type theElement

  XmlObjMgt_Element &

  param theString

  type theString

  TCollection_ExtendedString &

  rtype

  bool

static SetStringValue()

• 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

  param theElement

  type theElement

  XmlObjMgt_Element &

  param theData

  type theData

  XmlObjMgt_DOMString &

  param isClearText

  default value is Standard_False

  type isClearText

  bool

  rtype

  void

static SetTagEntryString()

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

  param theSource

  type theSource

  XmlObjMgt_DOMString &

  param theTagEntry

  type theTagEntry

  TCollection_AsciiString &

  rtype

  void

property thisown

The membership flag