Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
HyperGraph 2D
pulIMacro Class
pulIMacro GetParameterHandle
Returns a handle to the specified parameter.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
    - HyperGraph 2D
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
        pulIMacro AddParameter
        Adds a new parameter to the macro.
        pulIMacro Apply
        Applies the current macro.
        pulIMacro CopyParameter
        Copies the given parameter for the current macro.
        pulIMacro GetCreateNote
        Gets the “create note” value for the current macro.
        pulIMacro GetCreateTarget
        Gets the “create target” value for the current macro.
        pulIMacro GetExpression
        Returns the specified expression for the current macro.
        pulIMacro GetHideInputs
        Returns the value of the “hide inputs” flag.
        pulIMacro GetName
        Returns the name of the current macro.
        pulIMacro GetNoteText
        Returns the text of current macro’s note.
        pulIMacro GetNumberOfParameters
        Returns the number of parameters in the current macro.
        pulIMacro GetNumEntityInputs
        Returns the number of entity parameters in the current macro.
        pulIMacro GetParameterHandle
        Returns a handle to the specified parameter.
        pulIMacro GetTargetName
        Returns the name of the target (curve) created by the current macro.
        pulIMacro GetVarname
        Returns the varname of the current macro.
        pulIMacro PasteParameter
        Pastes the specified parameter, which has previously been copied.
        pulIMacro RemoveParameter
        Removes the specified parameter from the macro.
        pulIMacro SetCreateNote
        Sets the “create note” value for the current macro.
        pulIMacro SetCreateTarget
        Sets the “create target” value for the current macro.
        pulIMacro SetExpression
        Sets the specified expression to be the given expression for the current macro.
        pulIMacro SetHideInputs
        Sets the value of the “hide inputs” flag.
        pulIMacro SetName
        Sets the name of the current macro to the specified name.
        pulIMacro SetNoteText
        Sets the text of current macro’s note to the given text.
        pulIMacro SetTargetName
        Sets the name of the target (curve) created by the current macro to the specified name.
      - pulIMacroParameter Class
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

pulIMacro GetParameterHandle

Returns a handle to the specified parameter.

Syntax

pulIMacro GetParameterHandle param, index

Application

Tcl Query

Description

Returns a handle to the specified parameter.

Inputs

index: This command returns a handle to the parameter specified by index.
param: The handle can be accessed using the name specified by param.

Example

hwi GetSessionHandle sess
sess GetClientManagerHandle pm plot
pm GetMacroHandle macro 1
macro GetParameterHandle param_handle 1
puts [param_handle GetName]

Errors

Returns 3 if there is an invalid macro handle.

Returns 4 if index is less than 1 or greater than the number of parameters in the current macro.

Returns 1 if a handle to the specified parameter cannot be created.

Keywords

Macro

Tcl