Use contained names
- Last UpdatedSep 11, 2024
- 1 minute read
The contained name of a contained object only has to be unique in the context of its container.
An object can have three kinds of names, depending on whether it is contained by another object. The three names include:
|
Name |
Description |
|---|---|
|
Tag name |
The unique name of the individual object. For example, Valve1. |
|
Contained name |
The name of the object within the context of its container object. For example, the object whose tag name is Valve1 may also be referred to as Tank1.Outlet, if Tank1 contains it and it has the contained name "Outlet". |
|
Hierarchical name |
Hierarchical names that are fully-qualified names of a contained object include the names of the objects that contain it. Because the object that contains it may also be contained, there are potentially multiple hierarchical names that refer to the same object. For example, if: "Reactor1" contains Tank1 (also known within Reactor1 by its contained name "SurgeTank"). "Tank1" contains Valve1 (also known within Tank1 by its contained name "Outlet"). Valve1 could be referred to as: "Valve1" "Tank1.Outlet" "Reactor1.SurgeTank.Outlet". |
For example, an instance of a $Tank is named Tank01. An instance of $Valve called Valve01 is contained within the instance Tank01.
Change the contained name of Valve01 to InletValve. Now Valve01 can also be referred to by its hierarchical name Tank01.InletValve. The name of the contained object can be changed, though, within the scope of the hierarchy.
Contained names can be up to 32 alphanumeric or special characters. The second character cannot be $ and the name must include at least one letter. You cannot use spaces.