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
poIPost Class
poIPost GetAdvancedQueryHandle
Gets the handle to the advanced query.

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
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
        poIPost AddAdvancedQuery
        Adds the advanced query and returns the query ID.
        poIPost AddBestView
        Adds/creates a BestView entry to be used for showing individual entities.
        poIPost AddGraphicMaterial
        Adds a material to the database.
        poIPost AddMeasure
        Creates a measure.
        poIPost AddModel
        Loads the given model file, overlaying any existing models.
        poIPost AddModelToResultOverlay
        Adds the model to participate in Result overlay (multi-model plot).
        poIPost AddNote
        Adds a note.
        poIPost AddQueryRule
        Adds the query rule to the advanced query.
        poIPost AddResult
        Adds a result definition with the given label.
        poIPost AddResultMathAnalysis
        Adds a model and result pair to HyperView and enables result math.
        poIPost AddSection
        Adds a new section of the specified type to the current client.
        poIPost ApplyStyleTo
        Applies the style of the current model to another model on the current page, or on a different page in the session.
        poIPost ArrangeNotes
        Arranges the notes so that they are located near their attachment location, while being moved off of the model and legend areas.
        poIPost CancelLoading
        Cancels all loading operations that are in progress.
        poIPost CaptureImage
        Renders the current HyperView window to an off-screen image file.
        poIPost CaptureImageByRegion
        Renders a specific region of the current HyperView window to an off-screen image.
        poIPost Clear
        Resets the current post instance by removing all models and resetting the view (as well as any other post state).
        poIPost ClearBestViewNotes
        Clears the notes on all of the best views from the graphics area.
        poIPost CopyResult
        Copies a result definition from another definition.
        poIPost Draw
        Redraws the current window.
        poIPost ExportH3D
        Exports an H3D format file.
        poIPost ExportResultDefinitions
        Exports the result definitions to an XML file.
        poIPost GetActiveModel
        Gets the active model ID.
        poIPost GetAdvancedQueryHandle
        Gets the handle to the advanced query.
        poIPost GetAdvancedQueryList
        Gets the advanced query list.
        poIPost GetBestViewHandle
        Gets the handle of the best view.
        poIPost GetBestViewList
        Gets the list of best views present in the current session.
        poIPost GetBestViewTransparency
        Gets the transparency level applied for all best views.
        poIPost GetBoundaryMeshMode
        Gets the boundary mesh mode for section cuts and iso surfaces.
        poIPost GetDataComponentList
        Gets a list of all data components for all the models loaded.
        poIPost GetDataTypeList
        Gets a list with all data type labels for all the models loaded.
        poIPost GetDefaultMeasureType
        Gets the default measure type used when creating new measures.
        poIPost GetDisplayOptions
        Gets the measure display option setting.
        poIPost GetDisplayOptionsList
        Gets the list of post display options.
        poIPost GetFontList
        Gets the list of fonts available on your machine.
        poIPost GetGraphicMaterialHandle
        Gets a handle to a graphic material.
        poIPost GetGraphicMaterialList
        Gets the list of graphic material IDs in the database.
        poIPost GetLayerList
        Gets a list of shell layer labels from all the models loaded.
        poIPost GetMeasureAngleFormat
        Gets the angle format used by all measures in the window.
        poIPost GetMeasureDisplayMode
        Gets the global measure display option setting.
        poIPost GetMeasureHandle
        Gets a handle to the given measure by ID.
        poIPost GetMeasureList
        Gets a list of measure IDs.
        poIPost GetMeasureNumericFormat
        Gets the numeric format used by all measures in the window.
        poIPost GetMeasureNumericPrecision
        Gets the number of digits past the decimal to be displayed by all measures in the window.
        poIPost GetModelHandle
        Gets a handle to the given model by index.
        poIPost GetModelList
        Gets a list of the all model IDs in this window.
        poIPost GetModelReaderList
        Gets a list of model readers for a given model file. If no filename is given, then all model readers are returned.
        poIPost GetNoteHandle
        Gets the handle to the note.
        poIPost GetNoteList
        Gets a list of note IDs.
        poIPost GetNumberOfBestViews
        Gets the number of best views present in the current post client.
        poIPost GetNumberOfReaders
        Gets the number of readers.
        poIPost GetPerspectiveAngle
        Gets the value of the angle for the perspective view.
        poIPost GetQueryRuleHandle
        Gets the query rule handle from the client.
        poIPost GetQueryRuleList
        Gets the list of query rules from the client.
        poIPost GetQueryRuleTypeList
        Gets a list of all query rule types from the client.
        poIPost GetRenderOptionsHandle
        Gets the handle to the global graphics rendering options.
        poIPost GetResultHandle
        Gets a handle to the specified result definition.
        poIPost GetResultList
        Gets a list of defined result IDs of the given type.
        poIPost GetResultLoadProgress
        Gets the load progress as a percentage (from 0-100) for the given result.
        poIPost GetResultOverlayErrorList
        Gets the error list for Result overlay (multi-model plot).
        poIPost GetResultOverlayModelList
        Gets the list of model IDs which are participating in Result overlay (multi-model plot).
        poIPost GetResultPlotted
        Gets the plot status for the given result definition ID.
        poIPost GetResultReaderList
        Gets a list of result readers for a given result file. If no filename is given, then all result readers are returned.
        poIPost GetResultStatus
        Gets the load status for the given result definition ID.
        poIPost GetSectionDeformFrame
        If deformable sections are active, the interpolation frame, which was active when the section was cut, becomes planar.
        poIPost GetSectionDeformMode
        Gets the type of section cut: deformable or planar.
        poIPost GetSectionDeformTime
        Gets the time at which the section mode was changed to deformable.
        poIPost GetSectionHandle
        Gets a handle to the given section by ID.
        poIPost GetSectionList
        Gets a list of sections IDs.
        poIPost GetSectionViewAcceleration
        Gets the section cut acceleration.
        poIPost GetStyleList
        Gets a list of styles that can be applied to the other models.
        poIPost HideAllSections
        Hides all sections available in the window.
        poIPost ImportResultDefinitions
        Imports the result definitions from an XML file.
        poIPost IsCurrentModelOld
        Checks if the current model is old or new.
        poIPost RemoveAdvancedQuery
        Removes the advanced query.
        poIPost RemoveAllModels
        Removes all loaded models.
        poIPost RemoveBestView
        Removes the BestView.
        poIPost RemoveGraphicMaterial
        Removes the graphical material from the database.
        poIPost RemoveMeasure
        Removes the given measure by ID.
        poIPost RemoveModel
        Removes the given model by ID.
        poIPost RemoveModelFromResultOverlay
        Removes the model from participating in Result overlay (multi-model plot).
        poIPost RemoveNote
        Removes the note with specified ID.
        poIPost RemoveQueryRule
        Removes query rule from the advanced query.
        poIPost RemoveResult
        Removes a result definition with the given ID.
        poIPost RemoveSection
        Removes the given section by ID.
        poIPost SetActiveModel
        Sets the active model ID.
        poIPost SetBestViewTransparency
        Sets the transparency level for all best views.
        poIPost SetBoundaryMeshMode
        Sets the boundary mesh mode for iso and section cuts.
        poIPost SetDisplayOptions
        Sets the post display options.
        poIPost SetMeasureAngleFormat
        Sets the angle format used by all angle measures in this window.
        poIPost SetMeasureNumericFormat
        Sets the numeric format used by all measures in this window.
        poIPost SetMeasureNumericPrecision
        Sets the number of digits past the decimal to be displayed by all measures in this window.
        poIPost SetMeshMode
        Sets the mesh mode of non-visible geometry.
        poIPost SetPerspectiveAngle
        Sets the angle for the perspective view.
        poIPost SetSectionDeformMode
        Toggles the deformable section mode.
        poIPost SetSectionViewAcceleration
        Toggles the deformable section mode.
        poIPost SetTransparencyMode
        Sets the global flag controlling the display of non-visible geometry as transparent.
        poIPost WaitForResults
        Causes the application to wait for all of the results of the given type to load before returning.
      - 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.

poIPost GetAdvancedQueryHandle

Gets the handle to the advanced query.

Syntax

client_handle GetAdvancedQueryHandle advquery_handle id

Application

HyperView Tcl Query

Description

This command is used to get the advanced query handle with a specified ID.

Inputs

advquery_handle: Gets the advanced query handle.
id: Accepts the ID of the advanced query which is an integer.

Example

To get the advanced query handle:

hwi OpenStack
hwi GetActiveClientHandle client
set ruleID [client AddQueryRule mindist]
client GetQueryRuleHandle distance_rule_handle $ruleID
distance_rule_handle SetDistance "20"
hwi CloseStack

Errors

This command returns HW_InvalidHandle, if the core object associated with the client handle does not exist anymore.