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
GetLastSibling (FUN) ¶ FUNCTION GetLastSibling : IModule Returns the last child module instance of a given instance. Never returns 0. InOut: Scope Name Type Comment Return GetLastSibling IModule Input itfM IModule The instance that is queried for the last sibling (must not be 0)
GetNextModule (FUN) ¶ FUNCTION GetNextModule : IModule Returns the next module in depth-first preorder of the module tree. Returns 0 if (and only if) itfM is the last module in the preorder of the tree. InOut: Scope Name Type Comment Return GetNextModule IModule Input itfM IModule The module instance that is queried for the next instance (must not be 0)
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.