AMELibChecker

Rev 10 - November 2010

Copyright LMS IMAGINE S.A. 1995-2010 AMESim is the registered trademark of LMS IMAGINE S.A. AMESet is the registered trademark of LMS IMAGINE S.A. AMERun is the registered trademark of LMS IMAGINE S.A. AMECustom is the registered trademark of LMS IMAGINE S.A. LMS Imagine.Lab is a registered trademark of LMS International N.V. LMS Virtual.Lab Motion is a registered trademark of LMS International N.V.

ADAMS is a registered United States trademark of MSC.Software Corporation. MATLAB and SIMULINK are registered trademarks of the Math Works, Inc. Modelica is a registered trademark of the Modelica Association. UNIX is a registered trademark in the United States and other countries exclusively licensed by X / Open Company Ltd. Python is a registered trademark of the Python Software Foundation. Windows is the registered trademark of the Microsoft Corporation. All other product names are trademarks or registered trademarks of their respective companies.

TABLE OF CONTENTS
1. What is AMELibChecker? ................................................................................................ 1 Inputs ................................................................................................................................ 1 Outputs ............................................................................................................................. 1 2. Graphical User Interface .................................................................................................. 1 3. Defining the source path list ........................................................................................... 2 4. Selecting the destination directory................................................................................. 3 5. Applying the check submodels....................................................................................... 5 Information tab / info.log file .............................................................................................. 8 Check Report section / check_report.log file ................................................................... 10 6. Updating AMESim models ............................................................................................. 10

November 2010

Table of Contents

1/1

AMELibChecker user guide

1. What is AMELibChecker?
AMELibChecker is a tool which updates the libraries of user submodels and supercomponents when a new version of the AMESim application is used. These user submodels and supercomponents can be either generic or customized. AMELibChecker is intended for advanced AMESim/AMESet/AMECustom users who are used to making their own submodels and supercomponents. AMELibChecker goes through the AMESim path list and applies an automatic Check Submodels to the user submodels and supercomponents that are found in these directories. In the case where the Check Submodels is successful the submodels and supercomponents that have been updated are copied to a destination directory. The submodels and supercomponents that are already up-to-date before the Check Submodels is applied, are also copied.

Inputs
Inputs are the node directories where user submodels and supercomponents are stored.

Outputs
Outputs are node directories containing up-to-date submodels and supercomponents with their submodels.index and icon files. If no upgrade is applied, the submodel and supercomponent files that are copied to the destination directory keep their properties (access rights and dates). This is particularly true for submodel object files.

2. Graphical User Interface

AMELibChecker is a wizard application made of three pages: The first page is used to define the path list from which the user submodels and supercomponents are looked for. The second page allows the user to define the destination directory where the checked version of his libraries will be stored. The third page contains commands and controls for applying the Check Submodels to the user submodels and supercomponents. AMELibChecker 1/10

November 2010

3. Defining the source path list

The first page is designed to build a list of nodes (directories containing a submodels.index file) where user submodels and supercomponents are stored. Every submodel or supercomponent indexed in a node of the source path list will be checked. Please note that AMESim standard nodes are excluded from the source path list so that only the user submodels and supercomponents are checked. By default, the source path list is made from the AMESim/AMESet/AMECustom common path list from which the standard nodes are removed.

Figure 1: AMELibChecker

Clicking on the Full Path List button opens a dialog box which looks like the AMESim/AMESet/AMECustom path list. This allows the user to add (or remove) the nodes where his submodels and supercomponents are stored. The only difference with the standard AMESim/AMESet/AMECustom path list is that the Update Category check box does not appear. Any change from this path list is applied to the standard AMESim/AMESet/AMECustom path list. When the OK button is clicked, the current path list is used to generate the source path list from which the user libraries to upgrade are looked for.

November 2010

AMELibChecker

2/10

Figure 2: Path List

The Cancel button closes AMELibChecker. Please not that if the AMESim/AMESet/AMECustom path list has been previously modified and validated, the Cancel button will not set back the original path list. The Next button opens the second page of the AMELibChecker wizard.

4. Selecting the destination directory

The second page is used to define the path where the up-to-date submodels and supercomponents will be copied. A root destination directory must be chosen. The destination path list is then built from this directory. AMELibChecker generates the destination path list by appending the root directory with the name of the last subdirectory of each node from the source path list. November 2010 AMELibChecker 3/10

In the case where: several last subdirectories have the same name in the source path list or, a destination directory with a name that already exists is to be generated,

the suffix instance_i is appended to the destination directories. This guarantees that existing files are not overwritten since new empty destination directories are created before the Check Submodels starts.

Figure 3: Destination Path List

This button opens a directory browser. The OK button must be clicked when the destination root directory is selected: the destination path list is then generated.

November 2010

AMELibChecker

4/10

Figure 4: Select a directory The destination path list table shows the directories that will be created during the Check Submodels for storing the up-to-date submodels and supercomponents.

The Cancel button closes AMELibChecker. Please not that if the AMESim/AMESet/AMECustom path list has been previously modified and validated, the Cancel button will not set back the original path list. The Back button moves back to the first page of the AMELibChecker wizard. The Next button opens the third page of the AMELibChecker wizard.

5. Applying the check submodels

The third page deals with the Check Submodels facility. From this page, the Check Submodels can be started, followed and stopped. The messages sent by the Check Submodels tool are displayed in three tabs: Information, Errors and Check Report. Two progress bars indicate the state of the check process: one for the submodel or supercomponent currently being checked, and AMELibChecker 5/10

November 2010

one for the global process.

Figure 5: AMELibChecker page 3

Clicking on the start button starts the Check Submodels utility. When the check process is started every button is disabled except the Stop button. At the end of the Check Submodels, if 100% of the submodels and supercomponents have been upgraded, this button is disabled.

November 2010

AMELibChecker

6/10

Figure 6: Performing the check A dialog box summarizing the result of the process is displayed:

Figure 7: Summary We can get more details on the results by having a look at the Information, Errors and Check Report tabs. The three following files are also generated for saving these results: info.log, errors.log and check_report.log.

This button is only available when a Check Submodels is in progress. It must be used to stop the check.

November 2010

AMELibChecker

7/10

Please note that after a Check Submodels has been stopped, it can only be restarted from the beginning!

Information tab / info.log file

Figure 8: The Information tab Here we get the list of the up-to-date files that have been copied with their destination directory. Errors tab / errors.log file

November 2010

AMELibChecker

8/10

Figure 9: The Errors tab A list of all submodels and supercomponents which have not been upgraded is given. The reasons why they could not be updated can also be found and pieces of advice are given on how to upgrade them manually. When these problems are fixed, it is possible to restart the Check Submodels provided AMELibChecker has not been closed. In that case, only the submodels and supercomponents that could not be updated successfully will be dealt with and copied to their destination directory.

November 2010

AMELibChecker

9/10

Check Report section / check_report.log file

Figure 10: The Check Report tab Here we can find details on what has been modified in the submodels and supercomponents that have been checked.

6. Updating AMESim models

An automatic Check Submodels is applied to each model when it is opened in AMESim provided the version of the model is older than the version of AMESim. It is also possible to apply a Check Submodels to one or several models at once without having to start AMESim. This can be achieved by using the AMECirChecker utility. For more details on this utility, please refer to the AMECirChecker specific documentation.

November 2010

AMELibChecker

10/10

Support and contact information

Support General information on our products is available on our Solutions webpage: http://www.lmsintl.com/imagineamesim-1-d-multi-domain-system-simulation. Please refer to our Support webpage: http://www.lmsintl.com/support for information on current and upcoming releases, FAQs and a bug reporting form. You can also contact the Support desk of your local LMS Imagine Office directly. The corresponding e-mail address and phone number are indicated on our Support contact webpage: http://www.lmsintl.com/support/contact. For problems with a specific model, please send us a test case and a test procedure if possible. If result data is not needed, please purge the system concerned (using the AMESim Purge tool) and compress it before sending it. Please note that the scope of our Software Maintenance Service is limited as defined in your Software License Agreement. Contact information For more information on your local LMS Imagine Office (mail address for example), please refer to our Contact webpage: http://www.lmsintl.com/lmsworldwide.