moduleoperand module

Module moduleoperand aims to define SBSObjects that are relative to a module operand, mostly ModuleOperand.

class modulegraph.moduleoperand.ModuleOperand(aName='', aType='', aValue='', aDefaultValue='', aMetaData=None)

Bases: SBSObject

Class that contains information on a MDL graph as defined in a .sbs file

Members:

• mName (str): operand’s name.

• mType (str): operand’s type.

• mValue (str): operand’s value.

• mDefaultValue (str): operand’s value.

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

abstractmethod 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

abstractmethod 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

class modulegraph.moduleoperand.ModuleOperandMetaData(**kwargs)

Bases: SBSObject

Generic sbsobject to manage operand metadata values. Each given key:value metadata are set as attribute self.key = value.

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.

getAttr(key)

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

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

setAttr(key, value)

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