Serializing Parameters

Serializing to String

Parameter.getXML(forcePersistant: bool = False) → str

Returns a string containing the XML encoding of this parameter. If forcePersistant is True, even non-persistent parameters will be contained in this string.

Parameter.parseXML(xml: str) → None

Builds new parameters from the given xml string.

Parameter.replaceXML(xml: str, removeChildren: bool = True) → None

Redefines an existing parameter with the given xml, optionally deleting all existing children.

Serializing to XmlIO

Parameter.buildXmlIO(forcePersistant: bool = False) → Geolib3::XmlIO::v1::Element

Returns an XmlIO.Element representing encoding this parameter. If forcePersistant is True, even non-persistent parameters will be included.

Parameter.getValueXmlIO(element: Geolib3::XmlIO::v1::Element, time: float) → None

Adds this parameter’s value at the given time to the given XmlIO.Element, by setting attributes or adding child elements.

Parameter.setValueXmlIO(element: Geolib3::XmlIO::v1::Element, time: float, final: bool = True, sendNotifyMessage: bool = True) → None

Sets this parameter’s value from the given XmlIO.Element.

Parameter.parseXmlIO(element: Geolib3::XmlIO::v1::Element) → bool

Builds new parameters from the given XmlIO.Element.

Parameter.replaceXmlIO(element: Geolib3::XmlIO::v1::Element, removeChildren: bool = True) → None

Redefines an existing parameter using the given XmlIO.Element, optionally deleting all existing children.