SiblingRange (FB) ¶ FUNCTION_BLOCK FINAL SiblingRange IMPLEMENTS IModuleRangeForward The range of all siblings of a module instance. The order is as defined by the module tree. The range starts with a given module instance. Properties: First IsEmpty Methods: Init PopFirst Structure: First (Property) Init (Method) IsEmpty (Property) PopFirst (Method)

DepthFirstRange.Init (METH) ¶ METHOD PUBLIC FINAL Init Initializes the range with the first instance. InOut: Scope Name Type Comment Input itfM IModule The first instance of the depth first range

DepthFirstRange.IsEmpty (PROP) ¶ PROPERTY FINAL IsEmpty : BOOL Returns whether there are items left on the range or not

DepthFirstRange.PopFirst (METH) ¶ METHOD PUBLIC FINAL PopFirst Popos the first item out of the range

GetAncestorRange (FUN) ¶ FUNCTION GetAncestorRange : AncestorRange Returns the range of all ancestors of a given instance including this instance. InOut: Scope Name Type Comment Return GetAncestorRange AncestorRange Input itfM IModule The instance whose ancestors are of interest

GetChildRange (FUN) ¶ FUNCTION GetChildRange : SiblingRange Returns the range of all children of an instance. InOut: Scope Name Type Comment Return GetChildRange SiblingRange Input itfM IModule The instance whose child are of interest

GetDepthFirstRange (FUN) ¶ FUNCTION GetDepthFirstRange : DepthFirstRange Returns a range of all instances in the module tree in depth-first preorder of InOut: Scope Name Type Comment Return GetDepthFirstRange DepthFirstRange Input itfModule IModule The module which the depth first range shall use to start from

GetInstancePath (FUN) ¶ FUNCTION GetInstancePath : STRING(255) Returns the instance path of a module instance. The instance path is built by concatenating the instance names of all ancestors, starting from the toplevel module down until to the given instance. The instance names are separated by dots.l If the resulting instance name is longer than 255 characters, an empty string is returned. InOut: Scope Name Type Comment Return GetInstancePath STRING(255) Input itfM IModule The module instance for which the instance path is computed (must not be 0)

GetLastChild (FUN) ¶ FUNCTION GetLastChild : IModule Returns the last child module instance of a given instance. Returns 0 if (and only if) itfM has no children. InOut: Scope Name Type Comment Return GetLastChild IModule Input itfM IModule The instance that is queried for the last child (must not be 0)

GetLastInRange (FUN) ¶ FUNCTION GetLastInRange : IModule Returns the last element of a given range. Returns 0 if (and only if) the last element of the range is 0 or the range is empty. Note: after the call, the range will be empty. InOut: Scope Name Type Comment Return GetLastInRange IModule Input rng IModuleRangeForward The forward range (i.e. AncestorRange , DepthFirstRange or SiblingRange ) for which the last element shall be returned for