Topic 4.2.3 :Containment
- Creating Contained Templates
- Containment is the relationship in which one object includes
another. Containment relationships organize
objects in a hierarchy. You can build objects
that represent complex
devices consisting of smaller, simpler devices.
- In scripts, these objects can be referred to by the name that
derives from the containment relationship. This name is called a hierarchical
name.
- An object can have three kinds of names, depending on if it is
contained by another object. The three names include:
- Tagnames
- Contained Name
- Hierarchical Name
- Tagnames
- Contained Name
- Hierarchical Name
|
Name |
Description |
|
Tagname |
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 Tagname 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 name of the objects that contain it. Since 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". |
- Higher level objects contain lower level objects. This allows you to more closely model complex plant equipment, like tank systems. You can nest templates to 10 levels.
- Note: Objects can only contain objects like themselves. For example, ApplicationObjects can only be contained by other ApplicationObjects. Areas can only contain other Areas.
- Renaming Contained Objects
- Before you rename a contained name of an object, make sure that the object is not checked out to another user or currently deployed.
- The new contained name must comply with naming restrictions. Template names can be up to 32 alphanumeric or special characters, including the required $ as the first character. The second character cannot be $ and the name must include at least one letter. You cannot use spaces.
- Contained names also cannot be the same contained name as an existing contained object within the same level of hierarchy in the containment relationship.