CDP 4 User Manual

Manage Element Definitions and Element Usages

Plugin:

Introduction

This section will describe the details of managing the main modelling concepts within an engineering model. A high level description of the actions that are needed to setup and develop the actual design items in an engineering model is given in the topic develop engineering model. The details of using parameters to characterize the element definitions within an engineering model is described in the topic of managing parameters.

Manage Element Definitions

The element definitions as the main modelling items in the CDP4™ are managed in the Element Definitions browser. Open the Element Definitions browser by selecting the Open img icon in the Element Definitions group of the Model tab. The element definitions in this browser are given with their Name, Owner and have Element Definition as Row Type. A description of the available functionalities is given below. Next to these it is possible to use the generic functionality using the Search img and Help img icons. To make sure the latest data is shown in the browser, it is always possible to refresh it using the Refresh img icon. The element definitions modal dialogs further have the generic functionality on the Aliases, Definitions and HyperLinks tabs, described in the topic standard tabs.

Create Element Definition

To create a new element definition, select the Create Element Definition img icon or in the context menu select Create an Element Definition.

On the Basic tab, provide the mandatory fields for Name, Short Name and Owner. Furthermore, it is possible to indicate that the element definition is a Top Element, by ticking the check box Is Top Element.

Optionally, a category can be applied to the new element definition. To do this, provide the applicable category or categories by selecting these on the Categories tab. Given on this tab are only the categories that can be applied to element definitions. This is done by including element definitions in the list of permissible classes in managing the [categories][Cat].

To make use of the full advantages of ECSS-E-TM-10-25, it is advisable to indeed apply a well-defined category or categories to any element definition in the model. This will provide meaning to it and allows the model validation capabilities to function, e.g. by checking defined rules to inspect the model setup and consistency.

The element definitions that are created in the model need to get parameters assigned that characterize them, see the description of manage parameters. An element definition is shown with first the list of corresponding parameters, then the list of element usages (see below), both alphabetically ordered.

img img

Edit Element Definition

To edit an element definition, select the Edit Element Definition img icon or in the context menu select Edit. It is possible to edit most of the available fields on the Basic or content-specific tabs, as well as optional items on the other tabs for Aliases, Definitions, and Hyperlinks. In the case of Element Definitions, these are the Name, Short Name, Owner and indication of Top Element on the Basic tab, as well as the applicable categories on the Categories tab.

After making the required changes, click Ok.

Please take the effects of some of these edits into account. These are described below.

Inspect Element Definition

To inspect an element definition, select the Inspect Element Definition img icon or in the context menu select Inspect. In the Inspect modal dialog, all the details can be seen on the Basic and Category* tab, as well as optional tabs for **Aliases, Definitions, and Hyperlinks.

The Advanced tab provides information that may be useful mostly to CDP™ database administrators. Given are the UniqueID and the [Revision Number][Rev_Num].

Delete Element Definition

To delete an element definition, select the Delete Element Definition img icon or in the context menu select Delete.

When an element definition is deleted from the CDP™ database, it will actually be removed from the data that is stored in the CDP™ database from that point onwards.

Note that deleting an element definition will also delete all its related element usages.

Export Element Definition

To export element definitions, select the Export Element Definitions img icon.

Element Usages

Element Definitions can be added to other element definitions as Element Usages. This mechanism is used to create a hierarchy within the engineering model, see the section on option trees below. This section describes the more technical details of managing element usages.

Create Element Usage

When an Element Usage is being created, it has all the same characteristics in terms of name, short name and all the parameters that belong to it. To create an element usage, select a source element definition, and drag-and-drop this on the target element definition. With this action, an element usage with a link to the source element definition will be created under the target element definition. Any new element usage will be added to the alphabetically ordered list of element usages under an element definition. Element definitions are indicated with the Element Usage img icon in the Element Definitions browser.

Edit Element Usage

To edit an element usage, select the Edit Element Usage img icon or in the context menu select Edit. Note that for the Edit menu item, there is a choice to edit the Element Usage, or the corresponding Element Definition. It is possible to edit most of the available fields on the Basic or content-specific tabs, as well as optional items on the other tabs for Aliases, Definitions, and Hyperlinks.

In the case of Element Usages, these are the Name, Short Name and Owner on the Basic tab. The corresponding Element Definition cannot be edited.

It is further possible to edit the applicable categories on the Categories tab. Please note that any changes to these categories will only have an effect on this particular element usage. Any changes that are made to it do not impact the corresponding element definition, nor any of the other element usages. See the description below for more details on the effect of changes to element definitions and element usages. The categories of the corresponding element definition are given on the Definition Categories tab.

For an element usage, an additional attribute on the Basic tab is the Interface End. This specified the type of interface an element usage represents, if applicable. Possible choices for this are:

Another tab that is specific to element usages is the Options tab. On this tab, all the options that are specified within the iteration are given. It is possible to indicate if the element usage should be included or excluded for a specific option, see the description of nested elements and the option tree below. To exclude an element usage from an option, untick the check box for that option. Use the Select All check box to include or exclude the element usages from all options.

Inspect Element Usage

To inspect an element usage, select the Inspect Element Usage img icon or in the context menu select Inspect. Note that for the Inspect menu item, there is a choice to edit the Element Usage, or the corresponding Element Definition. In the Inspect modal dialog, all the details can be seen on the Basic, Options, ** Category* and **Definitions Category tab, as well as optional tabs for Aliases, Definitions, and Hyperlinks.

The Advanced tab provides information that may be useful mostly to CDP™ database administrators. Given are the UniqueID and the [Revision Number][Rev_Num].

Delete Element Usage

To export element usages, select the Export Element Usage img icon.

Nested Elements

Element Usages in the CDP4™ are used to build up nested element trees using the element definitions. The element definitions can be seen as “building blocks”, where the element usages are then used to specify where in a nested element tree these building blocks will appear.

An element definition has to be unique. Multiple element usages of a single element definition can be added however to an engineering model. Please note that the user should edit the element usage to create a unique name and shortname to distinguish between each usage if multiple usages are added to the same element definition, so it is not unique at that specific level.

The representation for each item in the Engineering Model browser itself is only one level deep. An element definition is shown with first the list of corresponding parameters, then the list of element usages, both alphabetically ordered.

One element definition in the engineering model can be indicated to be the Top Element, which will be the starting point to derive expanded option trees as nested element trees. For each element usage that is present within the element definition defined as the top element, its corresponding element usages within their corresponding element definitions will be collected, and so forth to recursively build up a fully expanded view of the model showing the nested elements.

This type of view on the model is available in the option-generated sheets.

Option Trees

Generating the Option Trees

The nested element trees are generated for each option specifically.

The distinction between the options can be expressed by indicating the desired option dependency of an Element Usage. If the option dependency is indicated for an element usage, this means that this element usage will be included in the nested element tree for that option when this is generated. By unticking the check box for an option, the element usage will be excluded from it, and the underlying parameters will not show up on the generated option sheet for that option. Setting the option dependency for element usages is thus one of the main mechanisms to create different nested element trees for different options to explore these as solution directions in a CD Study.

Including and Excluding Element Usages from Options

In the Element Definition Browser, an indication is given of the option dependency of element usages. If an element usage is included in all options, this is indicated with the green circles img icon, if used in none of the options a blue list img icon, and if not used in any of the options a red cross img icon.

To edit the element usage for the option dependency, clicking on the icon will display a drop-down menu with the available options. Use the check box to include or exclude the element usage for each specific option.

For any new option that is added to an iteration of the engineering model, the relevant items are updated to include it. The element usages will be updated, where these will all be set to be included for the new option. Make sure to review the list of applicable element usages after creating a new option if this is required.

img

Related Topics

Last modified 11 months ago.

^ Top