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
pltIMacro Class
pltIMacro IsComplexUseRI
Checks if the complex macro is in the real/imaginary plot.

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
        pltIMacro GetCurveAttachmentExpression
        Finds the curve that a curve note is attached to.
        pltIMacro GetCurvePointExpression
        Finds the point on the curve that the note is attached to.
        pltIMacro GetEditable
        Checks if the macro can be edited.
        pltIMacro GetNoteAttachment
        Finds where the note's attachment point.
        pltIMacro GetNotePositionX
        Finds the note’s X coordinate.
        pltIMacro GetNotePositionY
        Finds the note’s Y coordinate.
        pltIMacro GetXCoordinateExpression
        Gets the X coordinate of the point to which a coordinate note is attached.
        pltIMacro GetYCoordinateExpression
        Gets the Y coordinate of the point to which a coordinate note is attached.
        pltIMacro IsComplexMacro
        Determines if the macro is a complex macro.
        pltIMacro IsComplexNoteAttachPtInROP
        Checks if the attachment point of the complex macro note is in the real or phase plot.
        pltIMacro IsComplexNotePositionInROP
        Checks if the position of the complex macro note is in the real or phase plot.
        pltIMacro IsComplexUseRI
        Checks if the complex macro is in the real/imaginary plot.
        pltIMacro SetComplexMacro
        Sets whether the macro is a complex macro or not.
        pltIMacro SetComplexNoteAttachPtInROP
        Sets the attachment point of the complex macro note.
        pltIMacro SetComplexNotePositionInROP
        Sets the position of the complex macro note.
        pltIMacro SetCurveAttachmentExpression
        Sets the curve that the curve note is attached to.
        pltIMacro SetCurvePointExpression
        Sets the point on the curve that the curve note is attached to.
        pltIMacro SetEditable
        Sets whether the macro can be edited or not.
        pltIMacro SetNoteAttachment
        Sets the note attachment type.
        pltIMacro SetNotePosition
        Sets the position of the note.
        pltIMacro SetXCoordinateExpression
        Sets the X coordinate of the point to which a coordinate note is attached.
        pltIMacro SetYCoordinateExpression
        Sets the Y coordinate of the point to which a coordinate note is attached.
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - 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.

pltIMacro IsComplexUseRI

Checks if the complex macro is in the real/imaginary plot.

Syntax

pltIMacro_handle IsComplexUseRI

Application

Tcl Query

Description

This command determines if the complex macro is in the real/imaginary plot, rather than the phase/magnitude plot. If it is in the real/imaginary plot, the function returns true. If it is in the phase/magnitude plot, false is returned. This function only works if the macro is a complex macro.

Example

hwi GetSessionHandle sess;
sess GetClientManagerHandle pm Plot;
pm GetMacroHandle mh 1;
mc IsComplexUseRI;

Errors

Success (true or false) or an error message is returned.

Keywords

Tcl

Macro

Complex Plot

Query