GetPrevModule (FUN) ¶ FUNCTION GetPrevModule : IModule Returns the previous module in depth-first preorder of the module tree. Returns 0 if (and only if) itfM is the first module in the preorder of the tree. InOut: Scope Name Type Comment Return GetPrevModule IModule Input itfM IModule The module instance that is queried for the previous instance (must not be 0)
GetToplevelInstance (FUN) ¶ FUNCTION GetToplevelInstance : IModule Returns the toplevel instance of itfM. Never returns 0. InOut: Scope Name Type Comment Return GetToplevelInstance IModule Input itfM IModule The module instance that is queried for the toplevel instance (must not be 0)
GetToplevelRange (FUN) ¶ FUNCTION GetToplevelRange : SiblingRange Returns the range of all toplevel instances. InOut: Scope Name Type Comment Return GetToplevelRange SiblingRange Input itfMTree IModuleTree The module tree that holds all instances
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