Difference between revisions of "NVGate Macro"

- stop the "record on line".<br>

<Youtube>https://www.youtube.com/watch?v=6IIKsHwZi2Y</Youtube>

[[Image:Reports_Tools_Ribbons_58.png|200px|none]]

|}

|}<br clear="all">

Display the macros list and the associated hot-keys. A hot-key is a shortcut to run the macro.<br><br>

[[Image:Reports_Tools_Ribbons_60.png|300px|none]]

* '''Edit: '''Edits the macro selected. Available if no macro is being edited, recorded, or executed.

   

Sets a value to a parameter. The new value can be defined by a parameter.

[[Image:macro_break.png|border|500px]]

Used to exit a loop. It can be used inside a "for" loop to stop before the end of the iteration, inside a "while" loop to exit the loop without fulfilling the condition. It is the only way to exit a "Periodic loop".

Calls another macro.

The only parameter is the name of the macro that is called. The body of the command is divided into three steps in order to exchange parameters between the calling macro and the called macro.

The purpose of this command is to facilitate understanding of the macro. It is used to add a comment line to the body of the macro.

The only parameter is the comment.

[[Image:macro_for_loop.png|border|500px]]

Runs a set of commands several times. The number of iterations can be defined by an integer value or by an integer parameter.

This command retrieves the time and stores it in a string parameter. This string may be use to send a trace, to create a measurement name...

The "Time format" specifies the way in which the time should be written. "Date", "Time" and "Date and Time" use the regional settings of the host computer while the three other formats are fixed formats.

Gets the value of a parameter of a called macro. This command must be inserted between the "Exit macro" and the "Execute macro" commands, inside the body of the "Call Macro" command.

In this example, the command gets the value of the parameter nNumberOfLoop of the macro CheckInput and sets this value to the parameter nCount of the calling macro.

The purpose of this command is to facilitate understanding of the macro. It creates a branch that contains a set of instructions. It has no effect during execution, but it helps to organize the macro and facilitates copying and pasting, since all commands are copied at once.

[[Image:Reports_Tools_Ribbons_89.png|border|none]]

[[Image:macro_if_then.png|border|500px]]

|}<br clear="all">

[[Image:macro_incrementation.png|border|500px]]

Available if one or more integer or float parameter is defined.

Command used to create a string.

"Add to existing string" is a Boolean parameter that indicates if the second parameter replaces or is added to first one. If the value is false, the command behaves like the Affectation command

[[Image:macro_message_box.png|border|500px]]

When the command is executed, the box is displayed. A click on one of the buttons closes the message box and sets the Boolean parameter value.

[[Image:macro_periodic_loop.png|border|500px]]

Runs a set of commands at each interval of time specified in the "Time lap" parameter. The time lap is specified in seconds, the "Break" command must be used to exit the loop.

Sets the parameter value of a called macro. This command must be inserted between the "Open macro" and the "Execute macro" commands, inside the body of the "Call Macro" command.

The message generated in the top of the dialog box can be defined in the "command properties". A control is used to edit the parameter value. A click on the OK button changes the parameter value, and closes the dialog box. A click on the Cancel button closes the dialog box without changing parameter value.

[[Image:macro_set_parameter_value.png|border|500px]]

Command used to send a message in the log window.

"Play sound" is used to play a sound when the message is sent. The host computer must have speakers connected.

[[Image:macro_wait.png|border|500px]]

Waits for a given time. The wait time is specified in seconds.

[[Image:macro_while.png|border|500px]]

|}<br clear="all">

* '''Cut: '''Removes the command selected and copies it to the clipboard.

* '''Copy: '''Copies the command selected in the clipboard.