moduleparaminput module

Module moduleparaminput aims to define SBSObjects that are relative to a module parameter input, mostly ModuleParamInput.

class modulegraph.moduleparaminput.ModuleParamInput(aNodeUID='', aIdentifier='', aAnnotations=None)

Bases: SBSObject

Class that handle graph parameter input: operand exposed at graph level to drive another node’s operand ModuleParamInput will be exposed as SBSM’s parameter

Members:

  • mNodeUID (str): UID of the driven node

  • mIdentifier (str): the parameter input identifier

  • mAnnotations (list(ModuleAnnotation)): annotations that have parameter values

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getUidIsUsed(aUID)

Check if the given uid is already used in the context of this SBSObject.

Parameters:

aUID (str) – UID to check

Returns:

True if the uid is already used, False otherwise

Raise:

AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject

isAnInputParameter()
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)

Parse recursively the given xml node to retrieve the content of the SBSObject.

Parameters:

  • aContext (Context) – execution context

  • aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)

  • aSBSParser (SBSParser) – the substance parser

  • aXmlNode (xml.etree.ElementTree) – the xml node to parse

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

  • aSBSWriter (SBSWriter) – the substance writer

  • aXmlNode (xml.etree.ElementTree) – the xml node to fill