Import_export sciaXML. XML basics

Base

class import_export.sciaXML.xml_basics.Base.Base(id, t)

Bases: object

Base class for al sciaXML module objects.

getId()

Returns object identifier.

getT()

Returns T field.

id = ''
populateXMLElement(xmlElement)

Inserts items on xmlElement object.

setId(id)

Assigns object idenfier.

setT(t)

Assigns T field.

t = ''

Container

class import_export.sciaXML.xml_basics.Container.Container(id, t, table=None)

Bases: import_export.sciaXML.xml_basics.Base.Base

Table container.

appendTable(table)

Appends a table into the container.

getTables()

Returns container tables.

getXMLElement(parent)

Returns an XML element for the container. Parameters: parent: owner of this object in the XML structure.

Enum

class import_export.sciaXML.xml_basics.Enum.Enum(items)

Bases: object

Enumeration for SCIA XML.

getXMLElement(parent)

Returns the corresponding XML element for the enum object. Parameters: parent: owner of this object in the XML structure.

EnumItem

class import_export.sciaXML.xml_basics.EnumItem.EnumItem(v, t)

Bases: object

Item of an enumeration.

getXMLElement(parent)

Returns the corresponding XML element for the object. Parameters: parent: owner of this object in the XML structure.

Header

class import_export.sciaXML.xml_basics.Header.Header(h0=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h1=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h2=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h3=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h4=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h5=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h6=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h7=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h8=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h9=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h10=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h11=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h12=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h13=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h14=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h15=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h16=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h17=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h18=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h19=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>, h20=<import_export.sciaXML.xml_basics.HeaderItem.HeaderItem object>)

Bases: object

Header for SCIA XML.

getH0()
getH1()
getH10()
getH11()
getH12()
getH13()
getH14()
getH15()
getH16()
getH17()
getH18()
getH19()
getH2()
getH20()
getH3()
getH4()
getH5()
getH6()
getH7()
getH8()
getH9()
getXMLElement(parent)

Returns the corresponding XML element for the header. Parameters: parent: owner of this object in the XML structure.

setH0(h0)
setH1(h1)
setH10(h10)
setH11(h11)
setH12(h12)
setH13(h13)
setH14(h14)
setH15(h15)
setH16(h16)
setH17(h17)
setH18(h18)
setH19(h19)
setH2(h2)
setH20(h20)
setH3(h3)
setH4(h4)
setH5(h5)
setH6(h6)
setH7(h7)
setH8(h8)
setH9(h9)

HeaderItem

class import_export.sciaXML.xml_basics.HeaderItem.HeaderItem(t='')

Bases: object

getT()
getXMLElement(parent, count)

Returns the corresponding XML element for the object. Parameters: parent: owner of this object in the XML structure. count: counter.

setT(t)

Object

class import_export.sciaXML.xml_basics.Object.Object(p0=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p1=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p2=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p3=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p4=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p5=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p6=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p7=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p8=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p9=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p10=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p11=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p12=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p13=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p14=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p15=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p16=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p17=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p18=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p19=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p20=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>)

Bases: import_export.sciaXML.xml_basics.ObjBase.ObjBase

XML SCIA object with 21 items (ObjectItem) p0 to p10.

getNm()
getP0()
getP10()
getP11()
getP12()
getP13()
getP14()
getP15()
getP16()
getP17()
getP18()
getP19()
getP20()
getP3()
getP4()
getP5()
getP6()
getP7()
getP8()
getP9()
getXMLElement(parent)

Returns the corresponding XML element for the object. Parameters: parent: owner of this object in the XML structure.

setNm(nm)
setP0(p0)
setP10(p10)
setP11(p11)
setP12(p12)
setP13(p13)
setP14(p14)
setP15(p15)
setP16(p16)
setP17(p17)
setP18(p18)
setP19(p19)
setP20(p20)
setP3(p3)
setP4(p4)
setP5(p5)
setP6(p6)
setP7(p7)
setP8(p8)
setP9(p9)

ObjBase

class import_export.sciaXML.xml_basics.ObjBase.ObjBase(id, p1=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>, p2=<import_export.sciaXML.xml_basics.ObjectItem.ObjectItem object>)

Bases: object

getId()
getP1()
getP2()
getXMLElement(parent)

Returns the corresponding XML element for the object. Parameters: parent: owner of this object in the XML structure.

populateXMLElement(xmlElement)
setId(id)
setP1(p1)
setP2(p2)

ObjectItem

class import_export.sciaXML.xml_basics.ObjectItem.ObjectItem(v='', i='', n='', t='', h=None, rws=None)

Bases: object

Item of a table.

getH()

Returns h field.

getI()

Returns i field.

getN()

Returns n field.

getT()

Sets t field.

getV()

Returns v field.

getXMLElement(parent, count)

Returns the corresponding XML element for the object.

Parameters:
  • parent – owner of this object in the XML structure.
  • count – counter.
hasRows()

Returns true if rows are not empty.

setH(h)

Sets h field.

setI(i)

Sets i field.

setN(n)

Sets n field.

setT(t)

Returns t field.

setV(v)

Sets v field.

PropertiesContainer

class import_export.sciaXML.xml_basics.PropertiesContainer.PropertiesContainer(cId, clsid, progid)

Bases: import_export.sciaXML.xml_basics.Base.Base

SCIA XML properties container.

clsid = ''
populateXMLElement(element)

Returns an XML element for the object.

progid = ''

PropertiesSubTable

class import_export.sciaXML.xml_basics.PropertiesSubTable.PropertiesSubTable(id='', name='', typo='', clsid='', progid='')

Bases: import_export.sciaXML.xml_basics.PropertiesTable.PropertiesTable

SCIA XML properties sub table.

getXMLElementLabel()

Returns an XML element label.

PropertiesTable module

class import_export.sciaXML.xml_basics.PropertiesTable.PropertiesTable(id='', name='', typo='', clsid='', progid='')

Bases: import_export.sciaXML.xml_basics.TableBase.TableBase

getXMLElement(parent)

Returns the corresponding XML element for the table. Parameters: parent: owner of this object in the XML structure.

getXMLElementLabel()

Property

class import_export.sciaXML.xml_basics.Property.Property(x='', name='', typo='', id='', flag='')

Bases: object

SCIA XML property.

getXMLElement(parent)

Returns the corresponding XML element for the property. Parameters: parent: owner of this object in the XML structure.

Ref

class import_export.sciaXML.xml_basics.Ref.Ref(id, progid)

Bases: import_export.sciaXML.xml_basics.Base.Base

SCIA XML reference.

getXMLElement(parent)

Returns the corresponding XML element for the reference.. Parameters: parent: owner of this object in the XML structure.

Row

class import_export.sciaXML.xml_basics.Row.Row(id, p1, p2)

Bases: import_export.sciaXML.xml_basics.ObjBase.ObjBase

class import_export.sciaXML.xml_basics.Row.RowP012(id, p0, p1, p2)

Bases: import_export.sciaXML.xml_basics.Row.Row

getXMLElement(parent)

Returns the corresponding XML element for the row. Parameters: parent: owner of this object in the XML structure.

populateXMLElement(xmlElement)
class import_export.sciaXML.xml_basics.Row.RowP0123(id, p0, p1, p2, p3)

Bases: import_export.sciaXML.xml_basics.Row.RowP012

populateXMLElement(xmlElement)

TableBase

class import_export.sciaXML.xml_basics.TableBase.TableBase(id='', t='', name='')

Bases: import_export.sciaXML.xml_basics.Base.Base

Base class for al sciaXML tables.

getName()
populateXMLElement(xmlElement)
setName(name)

TableXMLNodes

class import_export.sciaXML.xml_basics.TableXMLNodes.TableXMLNodes(id='', t='', name='', h=<import_export.sciaXML.xml_basics.Header.Header object>, objects=None)

Bases: import_export.sciaXML.xml_basics.TableBase.TableBase

Table of XML nodes (NOT FE nodes).

extend(objects)

Extends table objects.

getHeader()

Returns table header.

getObjects()

Returs table objects.

getXMLElement(parent)

Returns the corresponding XML element for the table. Parameters: parent: owner of this object in the XML structure.

setHeader(h)

Sets table header.