IModuleRangeForward (ITF) ¶ INTERFACE IModuleRangeForward A forward range that represents a range of module instances. A forward range is similar to an iterator in Java or an enumerator in C#. Properties: First IsEmpty Methods: PopFirst Structure: First (Property) IsEmpty (Property) PopFirst (Method)
IModuleRangeForward.First (PROP) ¶ PROPERTY First : IModule Returns the first instance in the current range. May only be called if IsEmpty is FALSE.
IModuleRangeForward.IsEmpty (PROP) ¶ PROPERTY IsEmpty : BOOL Returns whether the range is empty. The property First may only be called if IsEmpty is FALSE.
IModuleRangeForward.PopFirst (METH) ¶ METHOD PopFirst Removes the first instance from the range. May only be called if IsEmpty is FALSE.
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
