RADE

C++/JAVA Interactive Dashboard

Workbench Commands Mapping

Correspondence between Workbench commands and RADE Dashboard

  or Visual Studio.NET and Visual Studio 2005 menus

Quick Reference

Abstract

This article has been written for people getting skills using Workbench commands [1], either with Windows or Unix platforms. They will find here what are the menus corresponding to these commands and how command options have been mapped to graphic items such like check or combo boxes. This article can also be read by people willing to work on Unix platform where only shell commands are available, it is a way for them to find the commands hidden behind Visual Studio.NET and  Visual Studio 2005 windows.

Some conventions are used in this article:

  1. Labels of buttons or menus which are extracted from Visual Studio.NET and  Visual Studio 2005 are written using "this format".
  2. Except for the commands written below in the summary, when command names appear as hypertext links, they refer to the corresponding command reference pages.

This article is divided into the following sections:


Setting up the Working Environment

In a DOS/shell Window With NT platform:
Execute following commands to access mkmk:
  • tck_init.bat
  • tck_profile CXR17

With Unix platform:
Execute following commands to access mkmk:

  • . tck_init.bat
  • tck_profile CXR17

 

From Interactive Dashboard

 

From the File menu, select the Open CAA V5 Workspace command.

 

[Top]

mkmk Commands

Setting Workspace Prerequisites

 

In a DOS/shell Window

 

There are two ways of setting prerequisites: you can copy them into your workspace with mkCopyPreq or register the workspace containing them:
  1. mkCopyPreq: static access
  2. mkGetPreq: dynamic access

In the window displayed in the right side, the "Copy prereq ..." radio button corresponds to the mkCopyPreq command and the "Use Prereq ..." radio button corresponds to the mkGetPreq command. In this example, the corresponding command is:

mkGetPreq -p
  H:\BSF;E:\Program Files\Dassault Systemes\B17D04

 

From Interactive Dashboard From the CAAV5 Workspace menu, select Locate Prerequisite Workspaces....

Note that the first directory you set in the list will be the first browsed when searching for prerequisites afterwards. You can change directory order by selecting a directory in the list and click on the arrow Up and Down buttons.

You can specify additional options by clicking the Specify other options button, which is especially useful for the mkCopyFw command.

The first mode gives you dynamic access (mkGetPreq), the second static (mkCopyPreq) and the third combines both modes by copying your prerequisites in a directory different from your own (mkCopyPreq to an other directory, followed by mkGetPreq referencing this directory).

 

   

[Top]

Copy Framework(s)

In a DOS/shell Window

 

The command to copy framework(s) from a workspace to another is mkCopyFw. Our sample dialog box corresponds to this command:
mkCopyFw -update VisualStudio -d

Using the dialog box, you enter the path to the origin workspace(s) in the top list, then type the name of the framework(s) you want to copy (use <space> between two framework names), you can filter the modules to copy by clicking on the "Add..." button associated with the middle list (at least one framework name must have been typed in before).

 

From Interactive Dashboard

 

From the Open menu select the CAAV5 Workspace and  Copy Framework... commands.
 

The check boxes in the "Copy Options" area correspond- from top to bottom - to the following options: -nm, -no, -d, -f, -update and -remove.

[Top]

Run mkmk

In a DOS/shell Window Run mkmk with appropriate options regarding the current directory and what you wand to compile. For instance:
$ mkmk -ug EnoviaDMC
$ cd VisualStudio
$ mkmk -ug CATVBTDevBase.m

Advanced users can take benefit from the mkGMake tool to compile just one file or to link a library. This is faster than running mkmk. This feature is available in Visual Studio.NET through the usual keyboard shortcuts which have been changed to run the CAAV5 builders: Ctrl-F7 and F7.

  • Ctrl-F7 starts the compilation of all source files in the current active project.
  • F7 starts the link of the project (module) corresponding to the source file currently active.

 

From Interactive Dashboard From the Build menu, select mkmk then select mkmk options, select the various modules, frameworks or whole workspace that you wish to compile and type additional options if any.

[Top]

Create the Runtime View

In a DOS/shell Window The command to build a Runtime View from a workspace is mkrtv

The items of the Dialog boxes correspond respectively to -c, -d, and -k options of the command.

 

From Interactive Dashboard From the CAAV5 Workspace menu, select Create/Update Runtime View....

[Top]

Run a CAA V5 application

Considering the Runtime View has been created...

In a DOS/shell Window

 

If you have built an executable, you can run it directly. If you have built a library, you run V5 by executing the following command: mkrun

The mkrun command is in charge of setting the runtime environment and then to run V5. Using Visual Studio.NET the runtime environment is already set and you can run V5 directly.

Like -keep option of mkrun is used to get a shell setting a proper environment, we can open from Visual Studio.NET a DOS window in which the runtime environment has been set, this is a convenient way for checking it's correct. To do this open menu "Window" and select "Open Runtime Window".

 

From Interactive Dashboard

 

From the Debug menu, select Start Without Debugging or use the shortcut  Ctrl+F5.

if you're not building an executable, you'll be prompted to enter the name of the executable to run, then type CNEXT, or select the CNEXT.exe module with the browse button from your Runtime View.

[Top]

Generate Online Documentation

In a DOS/shell Window

 

Online documentation is generated by two different commands depending on the type of data you want to document:
  1. mkman for C++ interfaces
  2. mkdcidl for IDL objects.

 

From Interactive Dashboard

 

From the CAAV5 Workspace menu, select Generate/Update Documentation..

There is nothing more to do, a log window is displayed while the documentation is being generated.

[Top]

Replay test objects

In a DOS/shell Window

 

Test objects that are delivered in a test framework of CAAV5 workspace can be run using mkodt command.

The test objects which are selected in the right side of the dialog box are specified using -s option on the command line.

From Interactive Dashboard

 

From the "Tools", select "Replay test-cases...".

The following window appears displaying the test objects found in test frameworks of your workspace. Select which ones you want to run and click on "OK".

You can also define additional variables, to take them into account only during the replay.

[Top]

mkCheckSource: Source Code Analysis

In a DOS/shell Window

 

mkCheckSource reads C++ source files to detect potential bugs like missing Release() on interfaces pointers. Sources to check are selected with the -s option on the command line.
From Interactive Dashboard

 

From the CAAV5 Workspace menu, select Check Source Files....

Select all files in the workspace, all files from a specified framework, all files for a specified module or a single source file. You can enable or disable warning messages and specify an optional file containing an alternate list of methods returning a pointer and needing a Release().
Click OK to start, a HTML viewer will be opened at command completion to display the generated report.

[Top]

Accessing Commands without Associated Menu Item

Once a workspace has been opened (for mkmk and/or for Workspace Manager usage) any command launched from Visual Studio.NET inherits environment variables and paths and can thus access mkmk or Workspace Manager commands. One command that can be run is the DOS interpreter, to do this:

In this window, you can access Workspace Manager or mkmk commands and therefore any command for which no interface is provided in VisualStudio.NET.

[Top]


References

[1] Summary of Commands around mkmk
[2] Customizing Visual Studio.NET and Customizing Microsoft Visual Studio 2005
[3] Working with the RADE Dashboard
[Top]

History

Version: 1 [Jan 2000] Document created
Version: 2 [May 2003] Document updated
Version: 3 [July 2005] Document updated
Version: 4 [January 2006] Document updated
[Top]

Copyright © 2006, Dassault Systèmes. All rights reserved.