automating tasks using adams/view scripting, macros, · pdf fileautomating tasks using...

Automating Tasks Using Adams/ViewScripting, Macros, and GUI

Customization

ADM 704B Course Notes

February 2013

Part Number: ADAM*V2012*Z*ADVVIEW*Z*SM-ADM704B-NT

Legal Information

MSC.Software Corporation reserves the right to make changes in specifications and other information contained in thisdocument without prior notice. The concepts, methods, and examples presented in this text are for illustrative andeducational purposes only, and are not intended to be exhaustive or to apply to any particular engineering problem ordesign. MSC.Software Corporation assumes no liability or responsibility to any person or company for direct or indirectdamages resulting from the use of any information contained herein.

Copyright © 2013 MSC.Software Corporation. All Rights Reserved. This notice shall be marked on any reproduction ofthis documentation, in whole or in part. Any reproduction or distribution of this document, in whole or in part, without theprior written consent of MSC.Software Corporation is prohibited.

The MSC.Software corporate logo, Adams, Dytran, Easy5, Fatigue, Laminate Modeler, Marc, Mentat, MD Nastran, MDPatran, MSC, MSC Nastran, Mvision, Patran, SimDesigner, SimEnterprise, SimManager, SimXpert and Sofy aretrademarks or registered trademarks of the MSC.Software Corporation in the United States and/or othercountries. NASTRAN is a registered trademark of NASA. All other trademarks belong to their respective owners.countries. NASTRAN is a registered trademark of NASA. All other trademarks belong to their respective owners.

Section Page

1 Command Language

What is in this Section 1-3

General Structure 1-4

Getting Familiar with Commands 1-7

Command Navigator 1-8

Command Window 1-10

Log File 1-12

Types of Commands 1-13

Exercise – Workshop 1 1-16

2 Conditional Constructs and Loops

CONTENTS

ADM704B, Section 0, February 2013Copyright© 2013 MSC.Software Corporation S0 - 3

2 Conditional Constructs and Loops


FOR/END Loop (Numeric Iteration) 2-4

FOR /END Loop (Object-Based) 2-8

WHILE/END 2-11

IF/THEN/ELSE 2-13


3 Macros: Overview


Macro Overview 3-4

Macro Object Parameters 3-7

Ways to Create Macros 3-8

Executing Macros 3-11

Section Page

3 Macros: Overview (Cont.)

Debugging Macros 3-14


4 Macros: Parameters

What is in this section 4-3

Types of Parameters 4-4

Generalized Format 4-5

Naming Conventions 4-6

Qualifiers and Formats 4-7

Default Characteristics 4-8

CONTENTS


Default Characteristics 4-8

Examples 4-9


5 Menus

What is in this section 5-3

Menu Builder 5-4

Syntax of Menu File 5-5

Using Commands to Add Menus 5-9


Section Page

6 Dialog Boxes


Adams/View Interface Overview 6-4

Terminology 6-5

Working with Dialog Boxes 6-6

Modifying Existing Pre-Built Dialog Boxes 6-7

Modifying Dialog Boxes that Were Auto Generated Using Macros 6-8

Creating Dialog Boxes from Scratch Using the Dialog Box Builder 6-9

Dialog Box Builder Overview 6-10

Dialog Box commands 6-14

CONTENTS


Dialog Box commands 6-14

Dialog Box Database Storage 6-16


7 Dialog Box Builder


Substituting Text into Commands 7-4

Working with Dialog Boxes 7-8

Buttons 7-9

Radio Boxes 7-10

Sliders 7-11

Containers 7-12

Option Menu 7-13

Saving Dialog Boxes 7-14


Section Page

8 Organizing Customization with Command Files


Build Files 8-4

Adams/View Startup Files 8-5


9 Plugins


Creating an Adams/View Library 9-4

Macros, Dialog Boxes as Children of a Library 9-6

The Plugin Load & Unload Macros 9-7

CONTENTS


The Plugin Load & Unload Macros 9-7

Adams/View Partial Binary Files 9-9

The Plugin XML File 9-10

Location for Plugin Files 9-11

Setting the MDI_USER_PLUGIN_DIR Variable 9-12

Test the Plugin 9-13


SECTION 1

COMMAND LANGUAGE


• General Structure

• Getting Familiar with Commands

• Types of Commands

WHAT IS IN THIS SECTION


• Syntax rules for commands

– Comment lines are allowed by placing an exclamation point (!) as the firstcharacter on the line.

– Continuation of a command is denoted by an ampersand (&) at the end of aline.

– Abbreviations are allowed as long as they are unique.

GENERAL STRUCTURE


• Examples:

– One “gotcha” when writing command files is that the last line might not getexecuted. Therefore, make it a habit of making the last line a commentcharacter (!).

– marker delete marker_name=.mod1.par4.mar27

– marker delete &

– marker_name=.mod1.part4.mar27

GENERAL STRUCTURE (CONT.)


– marker_name=.mod1.part4.mar27

– mar del mar=.mod1.par4.mar27

– mar del mar=mar27

• Syntax rules for entering values

– Values can contain letters, numbers, and underscore characters.

– They must begin with a letter or underscore character.

– Values can contain any characters that are enclosed by double quotationmarks.

– They must have separators (blank space or tab) between keywords andparameters. Placing separators between parameters and their values is

GENERAL STRUCTURE (CONT.)


parameters. Placing separators between parameters and their values isoptional.

– All parameter values of type string should be enclosed in double-quotes (“).

– All parameter values of type object will accept the full database name or therelative object name provided it is unique in the database.

• Command Navigator

• Command Window

• Log file

GETTING FAMILIAR WITH COMMANDS



– Enables you to browse through the Adams/View command language andexecute commands.

• The entire Adams/View command language is accessible through the CommandNavigator.

• Use the Command Navigator to navigate on keywords.

• Double-clicking the last keyword of a command displays a dialog box ofparameter names and parameter values.

GETTING FAMILIAR WITH COMMANDS (CONT.)


parameter names and parameter values.

Example:


Double-Click here


Which executes the command :xy_plots template delete title plot_name =plot_1

• Command Window

– Text-based way to enter commands.

– Assumes that you understand the Adams/View command language.

GETTING FAMILIAR WITH COMMANDS (CONT)

Command information area


Inputfield

• Command Window continued.

– Command History

• Use the up and down arrows on your keyboard to scroll through previouslyexecuted commands.

– Command Expansion

• Use a question mark (?) or the Esc key for help with completing commands:

– Completes keywords or parameter names.

– Prompts for keywords or parameter names.



– Prompts for keywords or parameter names.

– Prompts for parameter values.

• Log file

– A file named aview.log is saved during each Adams/View session. In thevertical applications, it is called acar.log, aengine.log, and arail.log.

– Contains commands that you entered and messages you received.

– The log file for the previous session is aview.log% on UNIX and aview.logon Windows.



• Adams/View commands can be categorized as follows:

– Model-based

• Examples:

– marker create marker_name=mar1 location=2,0,0

– marker modify marker=mar1 orientation=0d,90d,0d

– Interface-based (GUI)

• Example:interface dialog_box display &

TYPES OF COMMANDS


interface dialog_box display &

dialog_box_name = .gui.db_beam_size &

parameters=”$f_beam_name”

• Conditional constructs

– Adams/View command language contains commands for creatingconditional constructs and loops.

• BREAK

• CONTINUE

• IF/ELSEIF/ELSE/END

• FOR/END

TYPES OF COMMANDS (CONT.)


• RETURN

• WHILE/END

• File text write

– This command writes information from Adams/View into a text file. Youcontrol the format of the output and, using database access expressions,you can write any model or simulation data from the Adams/View database.

Note: For more information on the file text write command, see KnowledgeBase Article KB8012767 available at:http://simcompanion.mscsoftware.com/infocenter/index?page=content&id=K

TYPES OF COMMANDS (CONT.)


http://simcompanion.mscsoftware.com/infocenter/index?page=content&id=KB8012767

This command is also documented in the online help.





• Perform Workshop 1, “Understanding the Command Language,” inyour exercise workbook

EXERCISE


SECTION 2

CONDITIONAL CONSTRUCTS AND LOOPS


• FOR/END Loop (Numeric Iteration)

• FOR/END Loop (Object-Based)

• WHILE/END

• IF/THEN/ELSE



• Overview

– The FOR and END commands allow you to execute a group of commandsa fixed set of times.

– This example performs numeric iterations. Adams/View executes thecommands bracketed by the FOR and END for each value of a variable inthe specified range.

– You can nest any combination of looping (FOR/END, WHILE/END) andconditional constructs (IF/ELSEIF/ELSE/END).

FOR/END LOOP (NUMERIC ITERATION)


conditional constructs (IF/ELSEIF/ELSE/END).

• SyntaxFOR VARIABLE_NAME=var START_VALUE=REAL &

INCREMENT_VALUE=REAL END_VALUE=REAL

...

END

– Adams/View executes the commands between the FOR and END for eachvalue of var in the range START_VALUE to END_VALUE.

FOR/END LOOP (NUMERIC ITERATION) (CONT.)


– At the beginning of the FOR loop, Adams/View creates an Adams/Viewvariable of type REAL named var. Adams/View deletes the variable whenthe loop terminates. If you use the loop variable in an expression thatrequires it to persist, Adams/View issues a warning message and does notdelete the variable at the termination of the loop. If you do not want this tohappen, you can use the EVAL function.

– START_VALUE, INCREMENT_VALUE, and END_VALUE can be any validreal expression.

• Syntax continued

– INCREMENT_VALUE can be either positive or negative and defaults to 1.0if not specified.

• If INCREMENT_VALUE is positive, Adams/View increments the value of var bythe increment for each iteration and stops looping when the value of var isgreater than END_VALUE.

• If INCREMENT_VALUE is negative, Adams/View decrements var by theincrement for each iteration and continues looping until var is less than



increment for each iteration and continues looping until var is less thanEND_VALUE.

– The commands inside the FOR/END loop can use var as they would anyother Adams/View variable of type REAL.

• Example

– In this example, Adams/View creates 10 markers, MAR1 through MAR10,on the default part and locates them one unit apart on the x-axis of thepart’s reference frame.

for variable_name=tempreal start_value=1 end_value=10

marker create marker_name=(eval("MAR" // RTOI(tempreal))) &

location=(eval(tempreal-1)), 0, 0

end



end

• Overview

– The FOR and END commands allow you to execute a group of commandsa fixed set of times.

– This example operates on a set of Adams/View objects, such as markers orparts. Adams/View executes the commands bracketed by the FOR andEND on the specified set of objects.


FOR/END LOOP (OBJECT-BASED)



• SyntaxFOR VARIABLE_NAME=var OBJECT_NAMES=objects &

TYPE=database_object_type

...

END

– For this type of FOR loop, Adams/View creates an Adams/View variable oftype OBJECT and successively assigns the value of each object in the setto the variable. The commands inside the FOR/END pair can use var as

FOR/END LOOP (OBJECT-BASED) (CONT.)


to the variable. The commands inside the FOR/END pair can use var asthey would any other Adams/View variable of type OBJECT.

• Example

– In this example, Adams/View renumbers the ADAMS IDs of markersbelonging to the part follower; it starts at 5000 and increments by one foreach marker in the set.

variable create variable_name=ip integer_value=5000

for variable_name=the_marker object_names=.fourbar.follower.* type=marker

marker modify marker_name=(eval(the_marker)) adams_id=(eval(ip))

variable modify variable_name=ip integer_value=(eval(ip+1))

FOR/END LOOP (OBJECT-BASED) (CONT.)



end

variable delete variable_name=ip

• Overview

– Use the WHILE and END commands to execute a group of commands zeroor more times.

– Adams/View executes the commands that WHILE and END bracketrepeatedly until the condition associated with the WHILE command isFALSE (zero).


WHILE/END



• Syntax

WHILE CONDITION=(expression)...END

• Example

– In this example, Adams/View creates 10 markers, MAR1 through MAR10,on the default part and locates them one unit apart on the x-axis of thepart’s local part reference frame (LPRF).

variable create variable_name=ip integer_value=0

while condition=(ip < 10)

marker create marker_name=(eval("MAR"//ip+1)) &

location=(eval(ip)),0,0

WHILE/END (CONT.)


location=(eval(ip)),0,0


end

variable delete variable_name=ip

• Overview

– Use IF/ELSE to execute a group of commands conditionally.

– The execution of commands bracketed by IF and END depend on the valueof an expression.

IF/THEN/ELSE


• Syntax

IF/THEN/ELSE (CONT.)

IF CONDITION=(expression)

...

END


...

ELSE

Helpful operators for expressions:

!= not equal to

&& logical AND

|| logical OR

== equal to


...

END


...

ELSEIF

...

ELSE

...

END

== equal to

< less than

For information on these and otheroperators, see the ExpressionLanguage Reference in theAdams/View Function Builder onlinehelp.

• Example

– In the following example, if the marker MAR1 exists, Adams/View modifiesits location. If the marker does not exist, Adams/View creates it and sets itslocation.

if condition=(DB_EXISTS ("MAR1"))marker modify marker=mar1 location=2,0,0

elsemarker create marker=mar1 location=2,0,0

IF/THEN/ELSE (CONT.)


marker create marker=mar1 location=2,0,0

end

• Perform Workshop 2, “Conditional Constructs and Loops,” in yourexercise workbook

EXERCISE


SECTION 3

MACROS: OVERVIEW


• Macro Overview

• Macro Object Parameters

• Ways to Create Macros

• Executing Macros

• Debugging Macros



• Definition

– A macro is an object that adds a command to the Adams/View language toexecute a series of Adams/View commands.

– Adams/View treats a macro as it does all other Adams/View commands.

MACROS: OVERVIEW


• Purpose

– Automate model building, simulating, and reviewing

• Examples:

– Generate a series of objects

– Generate a series of plots for a simulation

– Build an entire model (one for parts, one for joints, one for forces, and so on).

– Automate user preferences

– You can also write macros to automate how you work in Adams/View. For

MACROS: OVERVIEW (CONT.)


– You can also write macros to automate how you work in Adams/View. Forexample, you can:

• Automatically turn icons on or off

• Specify a certain grid size

• Set whether or not to use the external Adams/Solver library, and so on.

• Examples:

– Icon settings (visibility, size, color)

– Grid settings (on/off, size, and so on)

– Solver preferences (use external/internal, save files, and so on)

• Types

– Parameterless

• Executes the Adams/View commands stored in the macro.

– With parameters

• You can add parameters to a macro that will be evaluated when the macro isexecuted.

• This makes the macro more generic.

MACROS: OVERVIEW (CONT.)


• To create a macro, you must specify:

– Name (for database storage and reference).

• We recommend that you save your macros in a user-created library.

• If you save them in the .gui library, they will not be upward compatible.

• By default, macros are saved at the root level of the database.

– A command that will run the macro.

• The default is the macro name.

MACRO OBJECT PARAMETERS


• The default is the macro name.

– The commands the macro will execute.

– What to do in case of a subsequent Undo.

• Macro editor

– Here, you enter the name of the macro and a unique command string thatexecutes the macro.

WAYS TO CREATE MACROS


Commandtext area

• Record/Replay

– You can create a macro by recording a sequence of steps. Once you startthe recording process, you perform the operations that you want to beincluded in the macro. Then, you stop the recording process and play itback. You can also save the macro you just recorded.

• Reading text from a file

– You can create a macro by using the Read command to read in an existing

WAYS TO CREATE MACROS (CONT.)


– You can create a macro by using the Read command to read in an existingcommand file containing the commands to be executed. You can alsoassign a help file or text string to the macro that explains the macro’s use.

– The file you supply that contains the macro definition is a standardcommand file but it can also contain parameters embedded in thecommands and can have special comments at the top.

• Example for reading text from a file

macro read &

file_name = "part_replicate_single_mac.cmd" &

macro_name = .par_rep_single

WAYS TO CREATE MACROS (CONT.)


• When you create a macro, the command is added to Adams/Viewlanguage.

• Command line

– Enter the command (with any applicable parameters) in the command lineof the Command Window.

EXECUTING MACROS


Commandline


– The Command Navigator displays a list of all Adams/View commandkeywords. When you select an object, a dialog box appears in which youenter parameters for executing the command.

EXECUTING MACROS (CONT.)

Selecting this command…


Selecting this command…

Opens thisdialog box

• Custom dialog boxes

– You can create a custom dialog box that upon execution executes a macro.

• Other macros

– If needed, a command within a macro can execute another macro.

EXECUTING MACROS (CONT.)


• Using list information and temporary variables

• Using the ADAMS Command Debugger

• Crawl-walk-run approach

DEBUGGING MACROS


• Using list information and temporary variables

– You can debug a macro if you:

• Create it in pieces.

• Store the pieces in variables.

• Get list information on these variables.

– For more information on building function expression strings in a macro, seethe Knowledge Base Article KB8013202, available at:http://simcompanion.mscsoftware.com/infocenter/index?page=content&id=K

DEBUGGING (CONT.)



• Using the ADAMS Command Debugger

– Used for heavy development

– Unsupported and details undocumented



• Crawl-walk-run approach

– Crawl - Learn the commands

• Use interface to facilitate.

• Execute by interface (GUI), Command Navigator, and so on.

• Review commands and parameters (log file and Command Window).

• Add to macro editor and test.

– Walk - Add parameters and qualifiers

• Declare parameters and simple qualifiers.

DEBUGGING (CONT.)


• Declare parameters and simple qualifiers.

• Substitute parameters into commands.

• Test.

• Add looping constructs, if necessary.

• Use temporary variables.

– Run - Fine tune

• Add comment lines

• Remove dependencies (model object names, environment, and so on).

• Add error trapping (using IF condition).

• Add detailed qualifier, as needed.

• Perform Workshop 3, “Macros Overview,” in your exerciseworkbook

EXERCISE


SECTION 4

MACROS: PARAMETERS


• Types of Parameters

• Generalized format

• Naming conventions

• Qualifiers and formats

• Default characteristics

• Examples



• Real

• Integer

• File

• Object

• String

TYPES OF PARAMETERS


• List

• Location

• Orientation

• The general format of a parameter is $’name:q1:q2:q3...’, where:

– name is the name of the parameter.

– q1, q2, q3... are one or more qualifiers that specify the characteristics of theparameter.

GENERALIZED FORMAT


• Must start with an alphabetic character.

• The rest of the name can include numeric characters andunderscores (“_”) as well as alphabetic characters (a-z, A-Z).

• The name ends at the first character that is not alphabetic,numeric, or an underscore. Therefore, $P, $P1, and $PART_1 arevalid parameter names while $PART#1 and $1P are invalid.

NAMING CONVENTIONS


• Not case sensitive.

• Use single quotes to explicitly separate the name or qualifiers fromcommand text immediately following the parameter.

• You can use qualifiers on the first occurrence of the parameter tocontrol the parameter characteristics.

– Qualifiers are optional.

– They can only be used the first time the parameter appears in the macrotext.

– You can use the qualifiers in any combination and any order.

– If repeated, ADAMS/View uses the last value.

QUALIFIERS AND FORMATS


– If repeated, ADAMS/View uses the last value.

– Qualifiers are not case-sensitive.

• Parameters can have one or more of the following qualifiers:

– Type

– Range

– Count

– Defaults

• We recommend that you explicitly set the characteristics of yourparameters in comments at the beginning of your macro.

• The first occurrence of a parameter in the command text definesthe parameter characteristics. This is true even if the firstoccurrence is in a comment.

DEFAULT CHARACTERISTICS


EXAMPLES

The qualifiers: Specify that the parameter requires:

$parts:t=part:c=2 Names for two existing parts.

$NSpokes:T=INTEGER:GE=3:LE=8:D=3

An integer from 3 to 8 and a constantdefault of 3.

$infile:t=file(*.dat) File name. The File Selection dialog


$cm_location_from_part:t=location:d=0,0,0$excitation_mode:t=list(heave,pitch,roll,warp):d=heave$error_variable:t=variable:d=.ACAR.variables.errorFlag$number_of_steps:t=integer:gt=0

For more examples of parameters, see the Customize tab in the ADAMS/Viewonline help.

$infile:t=file(*.dat) File name. The File Selection dialogbox lists all files with the extension.dat.

• Perform Workshop 4, “Macros and Parameters Syntax,” in yourexercise workbook

EXERCISE


SECTION 5

MENUS


• Menu Builder

• Syntax of Menu File

• Using Commands to Add Menus



• Overview

– You can use the Menu Builder (Tools Menu Modify) to modify andcreate menus to better suit your needs and preferences or match yourindustry’s terminology.

– You can specify keyboard accelerators (shortcuts) and mnemonics.

• Mnemonics create an underlined keystroke equivalent to a menu item, such asFile.

• Accelerators let you associate a key (such as F10) or key sequence (such as

MENU BUILDER


• Accelerators let you associate a key (such as F10) or key sequence (such asCTRL+k) with a menu item.

– You can build menus for a particular model or for an entire application. Forexample, you can add the elements shown below:

Menu Button

• Each line of a menu file defines an object and its name or specifiesinformation about the parent object.

• For clarity, Adams/View indents the lines. As you edit the text, you can alsoindent the lines.

• The figure below shows a portion of the Menu Builder that defines the Toolsmenu in Adams/View. Below the Menu Builder is the corresponding Toolsmenu as it appears in Adams/View.

SYNTAX OF MENU FILE


• Menu

– MENUn TITLENAME=nameHELP=Help

• Button

– BUTTONn LABEL :: ACCELERATORNAME=nameHELP=helpCMD=command

SYNTAX OF MENU FILE (CONT.)


CMD=command

• Separator

– SEPARATORn

• Toggle

– TOGGLEn TITLENAME=nameHELP=helpSTATE=stateCMD=command

• Referring to the example syntax on the previous page, the textlines have the following parameters:

– n is an integer between 1 and 10, usually 1, 2, or 3. It defines the menulevel in which the object appears. Level 1 is the first level.

• For example, if MENU1 appears on the menu bar, then BUTTON2 will appear under thepreceding MENU1.

• The n is required for MENU, but is optional for the other objects.

• If you omit the level, Adams/View assumes the object belongs under the last MENU.

• You can cascade menus up to 10 deep by nesting MENUs below other MENUs. You can



• You can cascade menus up to 10 deep by nesting MENUs below other MENUs. You caninclude as many buttons in a menu as you want; although, you should not create more thanwill fit on your screen.

– LABEL is the text that appears in the menu.– LABELs can contain ampersand (&) characters that specify keyboard mnemonic shortcuts

for a menu item (for example, ALT-F opens the File menu).

– For an icon button, you specify the icon name instead of the text. In Motif,the icon name is the name of a XBM (X BitMap) or XPM (X PixMap) formatfile. In Windows, the icon name is the name of a bitmap (.bmp) format file.

• The text lines have the following parameters continued:

– BUTTONs can specify an accelerator key (for example, CTRL+M,SHIFT+G, or F12) that invokes the button action.

– If NAME is omitted, Adams/View constructs a default identifier, such asMENU_4 or BUTTON_7.

– TOGGLE buttons create a menu item that displays a check mark dependingon the STATE value (ON or OFF). The state value is toggled when the



on the STATE value (ON or OFF). The state value is toggled when thebutton is clicked.

– SEPARATOR elements create horizontal line breaks that denote groups ofcommands.

– Note, that with the exception of CMD= lines, spaces are not permitted in themenu structure input. So NAME = my_menu is not valid, butNAME=my_menu is valid. This differs from Adams/View commandlanguage syntax where spacing rules are flexible.

• If you want to modify the Adams/View main menu, we highlyrecommend that you do this using commands instead of the MenuBuilder or .mnu file.

– If you modify a menu structure for one version of Adams/View and save it, itmay not represent the full, default, menu structure for subsequentAdams/View versions.

– For the above reason, it is better to use command language to build onlythe changes that you want rather than re-doing the entire menu structure.

USING COMMANDS TO ADD MENUS


the changes that you want rather than re-doing the entire menu structure.

• Perform Workshop 5, “Creating Custom Menu Buttons,” in yourexercise workbook

EXERCISE


SECTION 6

DIALOG BOXES


• Adams/View Interface Overview

• Terminology

• Working with Dialog Boxes

• Dialog Box Builder Overview

• Dialog Box Commands



• Dialog Box Database Storage

• Database hierarchy for graphical user interface (GUI) objects

ADAMS/VIEW INTERFACE OVERVIEW

All default objectsStored in .gui library


• Dialog Box and its children’s object terminology

TERMINOLOGY

Label

OptionMenu

Text box

Slider

Button

Dialogbox


Container

Toolstack

Radiobutton

Togglebutton

Separator

• Modifying existing pre-built dialog boxes

• Modifying dialog boxes that were auto generated using macros

• Creating dialog boxes from scratch using the Dialog Box Builder

WORKING WITH DIALOG BOXES


• Modifying existing pre-built dialog boxes

WORKING WITH DIALOG BOXES (CONT.)


• Modifying dialog boxes that were auto generated using macros.



• Creating dialog boxes from scratch using the Dialog Box Builder.



DIALOG BOX BUILDER OVERVIEW

Title

Dimensioningand Positioning

Toolbar

Attributes

Attribute typeselector


Attributesindicator

AttributesArea

DIALOG BOX BUILDER OVERVIEW (CONT.)

• You can access the Dialog Box Builder in one of two ways:

– From the Tools menu, point to Dialog Box and then select Create or Modify.

– Double-click on a dialog box.

• For security reasons, this method is disabled by default.

• You can enable this feature by either:

– Modifying or creating a dialog box for the first time

– Setting the environment variable MDI_AVIEW_CUSTOMIZE=enabled


• Operational modes for renaming, reshaping, and modifying

• Open objects in the Dialog Box Builder

– Name of open object is displayed in title.

– You can only modify characteristics (size, name, attribute) of the openobject and/or a direct child of the open object. In other words, you cannotmodify a “grandchild” directly.

– Limited to dialog boxes, containers, toolbars, and tab containers.



– Limited to dialog boxes, containers, toolbars, and tab containers.

– Open objects using the Dialog Box Open menus.

• Editing open object

– Use the Dialog Box menu to rename, fit, or edit its attributes.

• Editing children objects of open objects

– Double-click the object with the left mouse button (notice that the attributesindicator changes).

OR

– Select the object you want to modify:

• Single-click on an object with the left mouse button.

or



or

• From the Edit menu, point to Select and then browse for the object in theDatabase Navigator.

– Then, use the Edit menu to rename, resize, or edit its attributes.

• Start

– Commands are executed when object is displayed.

– Useful in initializing settings and putting default values into fields whenobject is displayed.

• Execution

– Commands are executed by the dialog box when the user clicks OK orApply.

DIALOG BOX COMMANDS


Apply.

• Finish

– Commands are executed when object is undisplayed.

– Allows you to clean up work when object is undisplayed.

DIALOG BOX COMMANDS (CONT.)


• Existing interface objects

DIALOG BOX DATABASE STORAGE

All dialog boxesare placed in thislibrary by default


• New GUI objects

– It is highly recommended that you place all new objects in a user-createdlibrary.

– Objects placed in the .gui library will not be upward compatible!

• Perform Workshop 6, “Working with Dialog Boxes,” in yourexercise workbook

EXERCISE


SECTION 7

DIALOG BOX BUILDER


• Substituting Text into Commands

• Working with Dialog Boxes

• Saving Dialog Boxes

WHATS IN THIS SECTION


• Holding down the right mouse button over the Commands area ofthe Dialog Box Builder displays a pop-up menu with severaloptions for editing the commands.

• When you select References, you can display and insert theavailable $xxx references.

SUBSTITUTING TEXT INTO COMMANDS


SUBSTITUTING TEXT INTO COMMANDS (CONT.)


• Objects that contain values



• Example



• Buttons

• Radio boxes

• Sliders

• Containers

• Option menu

WORKING WITH DIALOG BOX OBJECTS


• Buttons

– Buttons do not contain values.

– They simply execute commands upon single or double-clicking.

WORKING WITH DIALOG BOX OBJECTS (CONT.)


Buttons

Button

• Radio boxes

– Set states or modes



Radioboxes

Textappearance

Values

• Sliders

– Sets value of an object without having to type it in.

– Currently limited to integer values.


As you move the slider to theright, notice that value changes.


• Containers

– Sub-region inside dialog box windowor toolbar.

– Can hold other objects



Container fordesign study

• Option menu

– Allows one of many selections

– Contains a push graphic that displays the entire list, like a menu.

– Displays only one column of options.


When you select the arrow here…

You will get the pull-down menu


You will get the pull-down menuof available selections here

• On the Dialog Box menu, point to Export and then selectCommand File.

– The dialog box is saved in the current working directory.

– The file name will be the dialog box name.

– You will probably want to rename the file so that subsequent saves do notoverwrite the file.

– You can also save your dialog box by saving your modeling database as abinary file. All of your changes are saved if you save a binary file.

SAVING DIALOG BOXES


binary file. All of your changes are saved if you save a binary file.

• Perform Workshop 7, “Working with Dialog Box Builder,” in yourexercise workbook

EXERCISE


SECTION 8

Organizing Customization with CommandFiles


Files

• Build Files

• Adams/View Startup Files



• Files that read in (or create) the various components of a customizedinterface are typically called “build” files.

• We highly recommend that you organize all types of GUI customizationobjects in subdirectories for organization and easy access.

• Sample build file:

BUILD FILES


• Startup files

– Startup files are files that Adams/View searches for and loads automatically if theyexist.

– The following are the types of Adams/View startup files. They are listed in the order inwhich Adams/View searches for them:

• Aview.bin

– Used to save a customized Adams/View environment in binary format.

– Used to store the state of a specific modeling session.

– file is unique when compared to the other startup files. This is because it is always read

ADAMS/VIEW STARTUP FILES


– file is unique when compared to the other startup files. This is because it is always readin. By default, this file is located in the <install>/aview directory and will load in thedefault Adams/View session. Adams/View will open the Aview.bin file that it finds first.

• AviewBS.cmd

– Preferences that you set. Before Startup (BS) means that Adams/View reads thiscommand file before it reads other startup files.

• Aview.cmd

– Contains commands for starting Adams/View. This file tends to be more model/projectspecific.

• AviewAS.cmd

– Preferences that you set. After Startup (AS) means that Adams/View reads thiscommand file after it reads other startup files.

• You can use the startup files to:

– Automatically customize your interface (for example, menus, buttons, anddialog boxes)

– Speed up the file-import/open process

– Modify your Adams/View environment (for example, lighting features,layouts, and creating custom views)

ADAMS/VIEW STARTUP FILES (CONT.)


• Locations:

– Adams/View will read in the first startup file it encounters with the correctname (Aview.bin, AviewBS.cmd, Aview.cmd, and so on).

– Adams/View searches first for these files in your current working directory.

– If these files do not exist in your local working directory, Adams/Viewsearches for them in your directories specified in the aview.pth file.

– The aview.pth file is located by default in your <install>/common directory.



– The aview.pth file is located by default in your <install>/common directory.

• Perform Workshop 8, “Organizing Customization with CommandFiles,” in your exercise workbook

EXERCISE


SECTION 9

PLUGINS


• Creating an Adams/View Library

• Macros, Dialog Boxes as children of a Library

• The plugin Load & Unload Macros

• Adams/View partial binary files

• The plugin XML file



• Location for plugin files

• Setting the MDI_USER_PLUGIN_DIR variable

• Test the plugin

• A library is created from the command navigator as shown in the imagebelow.

• A library is just that: a container in which to hold other elements such asmacros, dialog boxes and variables.

CREATING AN ADAMS/VIEW LIBARY


• Set the ‘Filter’ to ‘All’ to see the library in the database navigator:

CREATING AND ADAMS/VIEW LIBRARY (CONT.)


• It is a good practice to write/test macros separately.

• Once they are complete, read them into the library using thecommand:

macro read file_name = "create_circular_pattern.mac" macro_name =.example_plugin.MACRO_1 create_panel = yes

– Note how the macro name indicates that the macro is a child of the library.

MACROS, DIALOG BOXES AS CHILDREN OF ALIBRARY


– Note how the macro name indicates that the macro is a child of the library.

– Dialog boxes are handled in a similar fashion

• Read the dialog box into View, naming it as a child of the library

OR

• Simply rename an existing dialog box (or macro) in your model such that it is thechild of the library.

PLUGIN LOAD AND UNLOAD MACROS


• When the plugin library is loaded, Adams/View looks for a specialmacro named LOAD under the library. If found, the macro isexecuted when the plugin is loaded.

• Similarly, an UNLOAD macro is sought when the plugin isunloaded; if found, Adams/View executes it.

• The LOAD and UNLOAD macros should do tasks such asloading/unloading custom menus in View.

PLUGIN LOAD AND UNLOAD MACROS (CONT.)


loading/unloading custom menus in View.

• Adams/View allows you to save portions of your existing databasesession into partial binary files

• Save the custom library to the partial binary file. The pluginautomatically loads this binary file giving access to yourcustomization library.

ADAMS/VIEW PARTIAL BINARY FILES


• <basename>_plg.xml file needs to be created so that theAdams/View Plugin Manager can find the plugin.

• The naming convention must be followed such that the<basename> is same as the prefix part of the partial binary file.

• For example:

example_plugin.bin

PLUGIN XML FILE


example_plugin_plg.xml

• Adams/View searches for plugin files in the following order:

– Current working directory

– Private location for product (ie: MDI_ACAR_PRIVATE)

– MDI_USER_PLUGIN_DIR environment variable

– Site location for product (ie: MDI_ACAR_SITE)

– System path (ie: $PATH, %PATH%)

– Installation path of Adams

LOCATION FOR PLUGIN FILES (XML, BIN)


– Installation path of Adams

– Library path (ie: $SHLIB_PATH, LD_LIBRARY_PATH)

• To set an environment variable, identify a folder location where thenecessary files will be placed then point the environment variableto this location.

• There are two ways to set an environment variable:

– Temporary method: Open a DOS command window and issue thecommand:

set MDI_USER_PLUGIN_DIR=C:\temp\plugindir

SETTING THE MDI_USER_PLUGIN_DIR VARIABLE


set MDI_USER_PLUGIN_DIR=C:\temp\plugindir

• Adams/View must be launched from this DOS shell so that the environmentvariable is properly picked up.

– Permanent method: Right-click on ‘My Computer’ on your machine andselect ‘Properties’. Under ‘Advanced’ tab select ‘Environment Variables’.Under ‘User variables’ create your new variable.

• Launch Adams/View from the DOS shell where theMDI_USER_PLUGIN_DIR environment variable was set.

• Go to Tools Plugin Manager and check whether your pluginappears in the list.

• Check on the plugin and hit OK to load the plugin. Verify that theplugin library is loaded, then test the customization in the library.

TEST THE PLUGIN


plugin library is loaded, then test the customization in the library.

• Perform Workshop 9, “Working with Plugins,” in your exerciseworkbook

EXERCISE


automating tasks using adams/view scripting, macros, · pdf fileautomating tasks using...

Documents