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
poIResultMathCtrl Class
poIResultMathCtrl GetSimulationLabel
Gets the label of a particular simulation.

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
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
        poIResultMathCtrl AddExpression
        Adds a new result math expression.
        poIResultMathCtrl AddResource
        Adds an external resource file to the current model.
        poIResultMathCtrl Commit
        Commits the result math expression to the data base to create a new user-defined data type.
        poIResultMathCtrl GetAlias
        Gets the alias string for the passed string.
        poIResultMathCtrl GetEquation
        Gets the result math equation string.
        poIResultMathCtrl GetEquationModeList
        Gets a list of possible modes which can be used with the GetEquation command.
        poIResultMathCtrl GetExpressionHandle
        Gets a handle to the result math expression.
        poIResultMathCtrl GetExpressionList
        Gets a list of result math expression IDs.
        poIResultMathCtrl GetID
        Gets the ID of the result math expression.
        poIResultMathCtrl GetLabel
        Gets the label of the result math expression.
        poIResultMathCtrl GetLibraryList
        Gets a list of result math libraries.
        poIResultMathCtrl GetNumResultMathResources
        Gets the number of additional result files that were loaded while using the Result Module to load models into HyperView.
        poIResultMathCtrl GetOperatorArgumentCount
        Gets the number of arguments for a particular result math operator.
        poIResultMathCtrl GetOperatorArgumentList
        Gets the argument names for a particular result math operator.
        poIResultMathCtrl GetOperatorDefaultArgumentSyntax
        Gets the syntax of the operator used in the expression builder when the default arguments are ignored.
        poIResultMathCtrl GetOperatorDescription
        Returns a brief description regarding the functionality of a result math operator.
        poIResultMathCtrl GetOperatorHelp
        Returns a description of a result math operator, and a brief explanation regarding the arguments and default values (if any).
        poIResultMathCtrl GetOperatorList
        Gets a list of operators for a particular library.
        poIResultMathCtrl GetOperatorSyntax
        Returns the syntax of the operator as used in the Expression Builder.
        poIResultMathCtrl GetResourceFilePath
        Gets the file path of an external result math resource.
        poIResultMathCtrl GetResourceLabel
        Gets the resource file name corresponding to a particular subcase ID.
        poIResultMathCtrl GetResourceList
        Gets a list of result math resources.
        poIResultMathCtrl GetResultMathResourceFileName
        Gets the file name corresponding to the index of the additional result file.
        poIResultMathCtrl GetSimulationLabel
        Gets the label of a particular simulation.
        poIResultMathCtrl GetSimulationList
        Gets the list of simulations for a subcase.
        poIResultMathCtrl GetSubcaseLabel
        Gets the label of a subcase.
        poIResultMathCtrl GetSubcaseList
        Gets a list of resources which contain the specified table name.
        poIResultMathCtrl GetTableComponentList
        Gets the components associated with a table.
        poIResultMathCtrl GetTableInfoList
        Gets the format and binding information of a table.
        poIResultMathCtrl GetTableLayerList
        Gets the layer list associated with a table.
        poIResultMathCtrl GetTableList
        Gets the list of tables from all resources.
        poIResultMathCtrl GetTableResourceList
        Gets a list of resources which contain the specified table name.
        poIResultMathCtrl RemoveExpression
        Removes an existing result math expression.
        poIResultMathCtrl SetEquation
        Sets the result math equation string.
        poIResultMathCtrl SetLabel
        Sets the label of the result math expression.
        poIResultMathCtrl SetSubcase
        Sets the subcase ID in which the user-defined data type will be created.
      - 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.

View All Altair HyperWorks Help

poIResultMathCtrl GetSimulationLabel

Gets the label of a particular simulation.

Syntax

rmath_handle GetSimulationLabel resource_name sub_id index

Application

HyperView Tcl Query

Description

This command retrieves the label of a particular simulation.

Inputs

resource_name: The name of the resource.
sub_id: The ID of the subcase.
index: The index of the simulation whose label is needed.

Example

To get the label of a simulation:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle

set mid [client_handle AddResultMathAnalysis "c:/samples/bumper/d3plot" "c:/samples/bumper/d3plot"]

client_handle GetModelHandle model_handle $mid
model_handle GetResultCtrlHandle result_handle
result_handle GetResultMathCtrlHandle rmath_handle

set res_list [rmath_handle GetSimulationLabel model 2 0]


hwi CloseStack

Errors

None.