The Focus application is useful for examining, editing, and correcting
SEDRIS Transmittal Format (STF) files (also called SEDRIS transmittals).
Focus can also run other SEDRIS-based tools, such as Depth,
Syntax Checker, Rules Checker, and Model Viewer, as well as read their error
reports. This release has been tested on Linux and Windows and is compatible
with SEDRIS 4.1.x, DRM 4.1.0, EDCS 4.4.0, and SRM 4.1.0. The
following image and text describes some of the important parts of the main Focus
window. The numbers in red correspond to the numbered comments below.
- A transmittal's structure will be displayed in the Tree View. Objects that appear
gray are ITR (Inter-Transmittal Reference) objects, and do not reside within the
transmittal that was opened through the GUI.
- As objects in the transmittal are selected by clicking on them, their fields
are displayed in the right side of the view.
- The path to the transmittal in the currently selected view is displayed
on the main window title bar.
- The Toolbar has buttons for editing and browsing
transmittals. The Toolbar can
be dragged to any side of the View Area or can be a floating window.
Additionally, some of the Toolbar functionality is
available via a right-click popup menu in the Tree View and also in
the Edit Menu.
File Menu
Open Transmittal
Open a transmittal using the File->Open Transmittal menu option. Shortcuts for
opening recent transmittals are available under
File->Recent Files. The number of shortcuts saved
can be specified in the Edit->Preferences->System pane.
Return to: Top
Open Transmittal Read Only
Open a transmittal using the File->Open Transmittal Read Only menu option.
Same as Open Transmittal but when opened in read only mode, the transmittal cannot be
edited. Shortcuts for opening recent transmittals are
available under File->Recent Files. The number of
shortcuts saved can be specified in the
Edit->Preferences->System pane.
Return to: Top
Recent Files
By hovering the mouse cursor over the Recent Files menu item a sub-menu will pop up
and display a number of recently opened or created transmittal files. Clicking on
one of these will re-open that transmittal, in the same mode (Read Only or Editable),
in a new view. The number of recent transmittals saved can be specified in the
Edit>Preferences->System pane.
Return to: Top
New Transmittal
When you create a new transmittal a default transmittal displayed. It contains
only a <Transmittal Root>. This can be used as a workspace for building,
cutting, and pasting objects to and from other transmittals.
Return to: Top
Close
Use the Close menu item when you want to close all open views of the currently
selected Transmittal.
Return to: Top
Save
Use this menu item to save all recent edits on the current transmittal to the disk.
This is useful when you want to run a tool such as Depth, Rules
Checker, Syntax Checker, or Model Viewer on the transmittal that you've been
editing. In previous versions of this tool you would have been required to close
the transmittal and Focus to save your changes before running a tool.
Return to: Top
Save As
Use this menu item to save all recent edits on the current transmittal to the disk
and change the name of the transmittal. Please note that you
need to have at least 2.5 times the hard disk space as the size of the transmittal
that you are saving to a different name.
Return to: Top
Exit
This item will close all transmittals and then shutdown the Focus application.
Return to: Top
Edit Menu
The Edit menu and the object right click menu are almost the same. Many of the
options presented on the Edit Menu are also on the Toolbar.
New
Please refer to the description of this menu item under the
Toolbar.
Return to: Top
Edit
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Copy/Paste Object/Paste Tree
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Delete
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Find
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Add Relationship
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Remove Relationship
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
Preferences
The following features are user configurable through this menu item:
System Preferences
The System preferences are the default parameters for display and
editing. Users can configure the display font size, look-and-feel, and the object
editing display format among others.
Return to: Top
Viewer Preferences
The Viewer preferences specifies how the transmittal is traversed and
displayed.
Return to: Top
Tools Preferences
The Tools Preferences can be used to either add new tools to Focus or
modify current tools.
To add a tool, Click on the "New" button then specify an
tool label, a short description to be displayed with the About button,
the path to the executable, and any command line arguments you want to add.
The currently available argument types are:
- Starting Object: used for the Starting Object ID
- Option: checkbox for a Boolean argument
- Integer:integer argument
- Integer with Option: integer with a checkbox for whether it should be
used or not
- Enumeration: enumerated list where one option is selected
- File: file name
- File with Option: file name with a checkbox for whether it should be
used or not
- String: string argument
An example of an Enumeration argument can be seen below.
Focus automatically builds a run window for each tool according to the options
saved, as seen in the following example for running the Depth tool:
Return to: Top
Tools Menu
Depth
Please refer to the description of this menu item under
Included Tools.
Return to: Top
Rules Checker
Please refer to the description of this menu item under
Included Tools.
Return to: Top
Syntax Checker
Please refer to the description of this menu item under
Included Tools.
Return to: Top
Model Viewer
Please refer to the description of this menu item under
Included Tools.
Return to: Top
View FOCUS Error Report
Two of the tools, Syntax Checker and Rules Checker, will output an
Error file by default. This file can be displayed by clicking the Show Errors
button on the Results window. The Errors will then be displayed in a
separate window. Clicking on an Error's Object ID button will select that
object in the Tree View. Error files can be saved and viewed using this
menu item.
Return to: Top
Bookmarks Menu
Bookmark
Please refer to the description of this menu item under
the Toolbar.
Return to: Top
This section of the menu shows all of the bookmarks for the currently selected transmittal.
Select one to view it.
Return to: Top
Window Menu
Cascade
This option will rearrange the current windows into a cascade formation as seen below:
Return to: Top
This option will rearrange the current windows into a tile formation as seen below:
Return to: Top
This section of the menu shows all the windows currently in the Edit area. Select one to bring that
window to the front if it's hidden and to expand the window if it's minimized.
Return to: Top
Help Menu
Users Guide
This document.
Return to: Top
The Release Notes document describes the specific related to each release
of this application. For example it describes the basic capabilities of Focus, the
platforms and libraries it's compatible with, and the changes made for this release
and previous releases.
Return to: Top
About Focus
This is a short description of the Focus application, it's version number, and what
SEDRIS library it's compatible with.
Return to: Top
The Toolbar has buttons for editing and browsing transmittals. The Toolbar can
be dragged to any side of the application or can be a floating window.
Additionally, some of the Toolbar functionality is available via a
right-click popup menu in the Tree View and also in
the Edit Menu.
Drag Handle
The drag handle allows the Toolbar to be repositioned in the application. The Toolbar
can be attached to any side of the application, or be detached as a floating window.
Return to: Top
Aggregate/Component Object
Aggregate and Component Objects are tree navigation buttons for selecting the
aggregate or component of the selected object in the tree hierarchy. For example if
a <Geometry Model> is selected through the associated <Geometry Model Instance>
then by clicking on the Aggregate button the aggregate of the <Geometry Model>,
which is a <Model>, will be selected.
Return to: Top
Previous/Next Sibling
The Previous and Next Sibling buttons are tree navigation buttons for objects at the same
level in the tree hierarchy under a single aggregate. For example if a <Table Property Description>
has four direct component <Property Characteristic>s and the first one is selected, clicking on
Next Sibling will move the selection to the next direct component <Property Characteristic>.
Return to: Top
Step Up/Down (in the Tree View)
The Step Up/Down buttons are the simplest navigation buttons and just step up or down in the
Tree View.
Return to: Top
New
This item brings up a menu for selecting a new object to create.
The newly created object will be pasted as a component of the
currently selected node. The object's fields will be initially set to default values.
Return to: Top
Edit
Edit allows an object's attributes to be edited. All object classes are
supported. There are two views of the editing window:
The List view lists all the field values in a scrollable pane.
The Tabular view displays one field at a time and the user can select
which to display by using the field tabs.
Return to: Top
Copy/Paste Object/Paste Tree
To make a copy of an object or tree, first select the object and then select
Copy in either the Edit Menu, the right click menu, or
the Toolbar. Once Copy is applied to the
currently selected node, you can then select a node under which the
copied node is to be created as a component. If you want to just copy the object by
itself then just select Paste Object. If you want to copy the object and it's entire
tree then select Paste Tree.
Return to: Top
Delete
Deletes the currently selected node, all relationships to / from it, and the
tree below it.
Return to: Top
Add Relationship
This button allows you to add either a component or a one-way/two-way associate
relationship. The currently selected node will automatically be added to the aggregate
or from object area when you click on this button. It can be changed at will by
selecting another node in the Tree View and then clicking on the button below the
object ID area for the aggregate/from object marked 'Get currently selected
node for this object'. To select a component/to object follow
the same procedure for changing the aggregate/from object and then click on the button
below the object ID area for the component/to object marked 'Get currently selected
node for this object'. After you choose both objects, either a green checkmark or
a red 'x' will show up to let you know if the relationship that you propose
to create is valid or not.
To create a component relationship, between the two objects you have selected,
click on 'Component' under the 'Relation Type'. To create an associate relationship,
between the two objects you have selected, click on 'Associate' under the 'Relation
Type'. If you select 'Associate' from the 'Relation Type' then the 'Direction Type'
box becomes active. Once the 'Direction Type' box becomes active then you need to
select whether you want a one-way or a two-way relationship.
If you see a green checkmark, you can click the 'Apply' button to create a relationship, or click
the 'Close' button to cancel.
Return to: Top
Remove Relationship
This button allows you to remove either a component or a one-way associate
relationship. The currently selected node will automatically be added to the aggregate
or from object area when you click on this button. It can be changed at will by
selecting another node in the Tree View and then clicking on the button below the
object ID area for the aggregate/from object marked 'Get currently selected
node for this object'. To select a component/to object follow the same procedure for
changing the aggregate/from object and then click on the button below the object ID
area for the component/to object marked 'Get currently selected node for this object'.
Regarding removal of associate relationships, this is only a one-way removal. To
remove a two-way association you need to remove both of the relationships separately.
Return to: Top
Find
Find allows an object to be selected and displayed in the view window by
specifying either the object's complete Object ID,
or by specifying a DRM class type and finding the first object of that
class in the tree hierarchy.
When using the DRM class type to search for objects, the
Previous Type/Next Object of Type toolbar
buttons become active to search forwards and backwards through the list of found
objects matching the type specified.
Return to: Top
Find Previous/Next Object of Type
Once an object of a DRM class is found using the Find
by DRM class type, the Previous and Next Type buttons will become active and
when clicked will select and show the previous (or next) object of the same
DRM class type in the tree. This feature always starts with the top-most object
of the specified DRM class type in the tree.
Return to: Top
Bookmark
Objects can be bookmarked for easy reference. To bookmark an object, select the
object in the Tree View and click the Bookmark tool on the
Toolbar, the Edit Menu, or the right-click menu and then give it a name.
The bookmark name will appear under the Bookmarks menu for that transmittal.
Selecting a bookmark from the list will cause that object to be selected and displayed
in the Tree View.
Return to: Top
Focus
Focus simply scrolls the selected object back into the view window. It is
useful for large transmittals where it is easy to lose sight of the selected
item when scrolling through large tree structures.
Return to: Top
New/Delete View
There can be multiple views for one transmittal. Each view can
display a different segment of the transmittal and have a different object
selected. To open another view for the transmittal currently being
displayed, hit the New View button on the toolbar. To delete the currently
displayed view, use the Delete View button on the right side of the
toolbar. If all the views for a transmittal are deleted, the transmittal will
be closed. To close all the views associated with the currently selected
one use the Close menu item in the
File Menu.
Return to: Top
Focus includes four SEDRIS-based tools that can be run directly in the Focus
interface from the Tools menu.
The tools included with Focus are:
Depth
Depth does a depth-first traversal of a transmittal.
Return to: Top
Rules Checker
Rules Checker checks a transmittal for compliance with constraints.
Return to: Top
Syntax Checker
Syntax Checker checks a transmittal for syntactical correctness.
Return to: Top
Model Viewer
Model Viewer allows you to view models and textures in a transmittal.
Return to: Top
A tool can be run on the currently selected transmittal by choosing the
tool from the Tools menu. If an object is selected and
the tool takes a start object as a parameter, the tool will be run
on that object, otherwise, the tool will run on the Transmittal Root. A
window will be displayed, presenting an About button which gives a short description
of the tool, and inputs for any command-line parameters. The tool
will be run in a separate process and the output will be displayed in a Results
window. The tool may be terminated while running by clicking the Kill
Process button on the Results window. Focus includes four SEDRIS tools:
Depth, Syntax Checker, Rules Checker, and Model Viewer.
Shown below is the window for the Depth tool before it is run:
The following image shows the output window and the associated buttons:
Two of the tools, Syntax Checker and Rules Checker, will output an Error file.
This file can be displayed by clicking the Show Errors button on the Results window.
The Errors will be displayed in a separate window as shown below:
Clicking on an Error's Object ID button will select that object in the Tree View.
From version 4.0.1.2 this button does not work for ITR objects.
Error files can be saved and viewed using the Tools>View
FOCUS Error Report option.
Return to: Top