Cross reference commands make it possible to create a list of other engineering objects which use the specified port (direct access port or interface port) in the function block diagram. In a function block diagram, a cross reference list is added at a point defined by an anchor, which is connected to the port. User can define this anchor to the function block diagram himself or let the tool place the anchor and the list. The query is made from the repositories of the engi-neering servers (EAS). These engiengi-neering servers (EAS) are defined in Settings Editor.
The best benefit of these commands is achieved if the location of anchors can be defined when the function block diagram is being created. Old function block diagrams may not have enough space for the lists and then the lists are output on top of other existing elements.
The structure of the Cross references menu is as follows:
Figure 51 Structure of Edit−Cross references submenu
7.10.1 Insert Anchor Up − Inserting an anchor (output upwards from a point)
An anchor is set to a function block diagram with the Insert Anchor Up command. When a cross reference list is generated later, the list will be output upwards from the location of the anchor.
When the Insert Anchor Up command is chosen, the tool asks to choose the symbol, which contains the port. It may be a separate direct access or interface port or a function block with a direct access port:
Select symbol:
Next you will be asked the anchor insertion point:
Insertion point:
An anchor can be defined at any point in a function block diagram. The name of a port is shown below the anchor.
Figure 52 An example of an anchor connected to a port
An anchor, or a symbol containing a port, can be moved afterwards from one point to another with the Move command. If the symbol is removed, the anchor is useless and it is deleted when a cross reference list is generated next time. Each port can have only one anchor.
7.10.2 Insert Anchor Down − Inserting an anchor (output downwards from a point)
The Insert Anchor Down command is like the Insert Anchor Up command except that the cross reference list is output downwards from the defined point when the list is generated.
7.10.3 Show Anchors − Showing anchors
Sometimes it is necessary to know which anchor is connected to a certain port. When the Show Anchor command is given a red line is drawn between the anchor and the port showing that those two belong together. The lines will disappear when the function block diagram is updated next time (View−Redraw).
7.10.4 Get References− Generating a cross reference list
This command generates a cross reference list, this is, a name list of engineering objects which use a certain port is fetched from the repository or workspace. First you will be asked:
Get reference to: 1:Anchor. 2:Selected ports. 3:All ports.
Option 1 generates cross reference lists for ports containing anchors. Option 2 generates lists for selected ports and option 3 generates lists for all ports.
The query is made from the default engineering server (EAS) but a query from several engi-neering servers (EAS) is also possible. The default server and other possible servers are de-fined in the Settings Editor.
Locating the list to the function block diagram
After a successfull generation the cross reference list is added to the function block diagram starting from the point where the anchor is defined. If no anchor is defined the tool starts searching for empty space and then places an anchor and the list there. The searching order is as follows:
1. Above the port
2. Above the port on left side 3. Below the port
4. Below the port on left side
5. On the left or right side of a page depending on which side is closer to the port.
6. On the other side of the page (right or left)
If there is no empty space the tool places the list above the port. When the tool locates the list it also defines an anchor to that point. So next time the anchor exists and the cross reference list is output into the same point. Note that after generating it is possible to move the list and the symbol containing port freely with the Move command.
Contents of cross reference list
A cross reference list contains the possible specifier or the name of the member and also the engineering object identifier which uses the port. If a port is used only in an independent con-figuration function (there is no design function), the identifier of the concon-figuration function is in parenthesis. If several engineering servers (EAS) are used, there is an engineering server name in parenthesis after the engineering object identifier. Cross reference lists are presented in alphabetical order as the following example shows:
Figure 53 An example of a cross reference list generated to the function block diagram
If the list does not contain specifier, the engineering object uses the whole port.
Often the port is used also e.g. in event and operation functions but usually they are not of interest. The default is that there is no engineering object identifier in the cross reference list if the prefix of the configuration function identifier is ’al:’, ’od:’, ’mw:’ or ’gd:’. This list of prefixes can be changed with the help of Exclude prefix list definition in Settings Editor.
Updating cross reference lists to the function block diagrams
It is recommended to locate the anchors of the cross reference lists when creating the function block diagram. However, the generation of the cross reference lists is better to execute only after all the function block diagrams are ready. It is recommended to use the SCRIPTALL command with which the same operation can be made to a whole group of function block diagrams. Additional information of the SCRIPTALL command can be found in the metsoDNA CR Maintenance Manual. There are two ready−made functions in the FbCAD and the SeqCAD with the help of which the generation of cross reference lists will succeed when using the SCRIPTALL command. These functions are the following:
(fb−get−refs−to−ports)
Function generates the cross reference list to all the ports of a function block diagram. The list is added to the anchor of each port. If no anchor is defined the tool starts searching for empty space and then places an anchor and the list there (see chapter 7.10.4 Locating the list to the function block diagram).
(fb−get−refs−to−anchors)
Function generates a cross reference list to the function block diagram for all the ports which have an anchor defined.
The following is an example of a script which is executed when using the SCRIPTALL com-mand:
(load “getext”)
(fb−get−refs−to−anchors “referr.txt”)
In the above example a list of engineering objects is created into the file referr.txt. These are the engineering objects which caused error messages while generating the cross reference lists.
The generation and updating of the cross reference lists can be set to be executed automatical-ly each time a function block diagram is opened by setting the Update variable to state 1 or 3 on the WDS tab of Settings Editor. The fuctions of the states are:
1 = Cross references are updated above or below the anchors of the function block diagram.
3 = In addition to updating cross references, anchors are added to each port of the function block diagram.
7.10.5 Make query − Making own query
If you want to make a cross reference query, but you do not want to add a list to the function block diagram, the query can be made with the Make query command. First you will be asked:
Enter external query:
A port name is inserted (e.g. ’pr:06K0001J1’ or ’pr:06K0001J1.F:out1’ ).
7.10.6 List References− Printing the cross reference lists
All ports and cross reference lists can be listed with the List References command. The list can be printed as well.