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.
HyperView
poIMeasure Class
poIMeasure GetMagnitudeDef
Gets the measure magnitude definition.

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
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
        poIMeasure AddDynamicCurveToPlot
        Adds a dynamic curve for this measure, using the specified y-axis, to the given plot client.
        poIMeasure AddDynamicXYCurveToPlot
        Adds a dynamic curve for all entities in the current measure group, using the specified y-axis, to the given plot client.
        poIMeasure AddElement
        Adds an element to the measure.
        poIMeasure AddEntity
        Adds the given entity to the measure from the specified model and pool.
        poIMeasure AddMinDistFromSet
        Adds the entity set used as the "from" set.
        poIMeasure AddMinDistToSet
        Adds the entity set used as the "to" set.
        poIMeasure AddNode
        Adds the given node of the current/specified model to the measure.
        poIMeasure AddStaticCurveToPlot
        Adds a static curve for this measure, using the specified y-axis, to the given plot client.
        poIMeasure AddStaticXYCurveToPlot
        Adds a static curve for all entities in the current measure group, using the specified y-axis, to the given plot client.
        poIMeasure AddSystem
        Adds a marker to the measure.
        poIMeasure CreateItem
        Creates the measure item.
        poIMeasure GetAverage
        Gets the calculated average for all measure items.
        poIMeasure GetBaseTime
        Gets the measure base time (for relative measures only).
        poIMeasure GetColor
        Gets the measure text color index.
        poIMeasure GetDisplayMode
        Gets the measure display option setting.
        poIMeasure GetDisplayModeList
        Gets a list of measure display modes.
        poIMeasure GetEntityList
        Gets a list of measure entities.
        poIMeasure GetEntityType
        Gets the measure entity type.
        poIMeasure GetEntityTypeList
        Gets the list of measure entities in a measure group.
        poIMeasure GetFontHandle
        Gets a handle to an hwIFont interface for the font of the measure.
        poIMeasure GetFromSetType
        Gets the "from" selection set type.
        poIMeasure GetID
        Gets the measure ID.
        poIMeasure GetItemList
        Gets a list of measure items which make up this measure.
        poIMeasure GetLabel
        Gets the measure label.
        poIMeasure GetMagnitudeDef
        Gets the measure magnitude definition.
        poIMeasure GetMaximum
        Gets the calculated maximum for all measure items.
        poIMeasure GetMinimum
        Gets the calculated minimum for all measure items.
        poIMeasure GetResultSystem
        Gets the measure result system ID.
        poIMeasure GetReviewMode
        Gets the review mode for the measure group.
        poIMeasure GetToSetType
        Gets the "to" selection set type.
        poIMeasure GetType
        Gets the measure type.
        poIMeasure GetTypeList
        Gets the possible measure types.
        poIMeasure GetValueList
        Gets a list of values for all items in the measure.
        poIMeasure GetVisibility
        Gets the measure visibility.
        poIMeasure HighlightEntitySet
        Highlights the "from" and "to" selections for the measure item.
        poIMeasure IsItemLinked
        Gets if the measure item is dynamically linked to a curve or not.
        poIMeasure RemoveItem
        Removes the given measure item.
        poIMeasure SetBaseTime
        Sets the measure base time (for relative measures only).
        poIMeasure SetColor
        Sets the measure text color.
        poIMeasure SetDisplayMode
        Sets the measure display mode.
        poIMeasure SetLabel
        Sets the measure label.
        poIMeasure SetMagnitudeDef
        Sets the measure magnitude definition.
        poIMeasure SetResultSystem
        Sets the measure analysis system.
        poIMeasure SetReviewMode
        Sets the review mode for the measure group.
        poIMeasure SetType
        Sets the measure type.
        poIMeasure SetVisibility
        Sets the measure visibility.
        poIMeasure UnlinkItem
        Unlinks the live connection between this measure item and the curve to which it's connected.
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - HyperGraph 2D
    - 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.

poIMeasure GetMagnitudeDef

Gets the measure magnitude definition.

Syntax

poIMeasure_handle GetMagnitudeDef

Application

HyperView Tcl Query

Description

This command retrieves the measure magnitude definition. Only valid for a distance type measure resolved in a rectangular system (including Relative Displacement, Distance Between, Incremental Distance, Minimum Distance). Measure magnitude definition includes:

X+Y+Z: xyz norm = sqrt(x^2+y^2+z^2)

X+Y: x-y norm = sqrt(x^2+y^2)

X+Z: x-z norm = sqrt(x^2+ z^2)

Y+Z: y-z norm = sqrt(y^2+z^2)

None: Do not show magnitude and define as X+Y+Z.

Errors

Returns 0 if successful, otherwise an error code.