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
poIAdvancedQuery Class
poIAdvancedQuery SetScalarDefine
Sets the scalar define ID.

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
        poIAdvancedQuery AddSimulations
        Adds the simulation to the advanced query.
        poIAdvancedQuery CreateBestViews
        Creates BestView entries for every hotspot found by the advanced query.
        poIAdvancedQuery GetID
        Gets the ID of the advanced query.
        poIAdvancedQuery GetLabel
        Gets the label of the advanced query.
        poIAdvancedQuery GetNumericFormat
        Gets the numeric format from the advanced query.
        poIAdvancedQuery GetNumericPrecision
        Gets the numeric precision from the advanced query.
        poIAdvancedQuery GetOutputSelectionSethandle
        Gets the selection set handle which holds the IDs of the result output.
        poIAdvancedQuery GetQuery
        Gets the output query string.
        poIAdvancedQuery GetQueryLogic
        Gets the rule of the advanced query.
        poIAdvancedQuery GetScalarDefine
        Gets the scalar define ID.
        poIAdvancedQuery GetSearchOption
        Gets the search options status from the advanced query.
        poIAdvancedQuery GetSearchOptionList
        Gets the list of search options from the advanced query.
        poIAdvancedQuery GetSimulationList
        Gets the list of simulations applicable for the advanced query.
        poIAdvancedQuery GetSubcaseList
        Gets the subcase list applicable for the advanced query.
        poIAdvancedQuery GetValueList
        Gets the values from the advanced query.
        poIAdvancedQuery RemoveSimulations
        Removes the simulations from the advanced query.
        poIAdvancedQuery SetLabel
        Sets the label to the advanced query.
        poIAdvancedQuery SetNumericFormat
        Sets the numeric format for output values.
        poIAdvancedQuery SetNumericPrecision
        Sets the numeric precision for output values.
        poIAdvancedQuery SetQuery
        Sets the query string in the advanced query.
        poIAdvancedQuery SetQueryLogic
        Sets the query logic to the advanced query.
        poIAdvancedQuery SetScalarDefine
        Sets the scalar define ID.
        poIAdvancedQuery SetSearchOption
        Sets the search options status to the advanced query.
        poIAdvancedQuery WriteData
        Writes the output data to files.
      - 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
      - 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.

poIAdvancedQuery SetScalarDefine

Sets the scalar define ID.

Syntax

advancedQuery_handle SetScalarDefine id

Application

HyperView Tcl Modify

Description

This command sets the ID of the scalar define.

Inputs

id: The scalar define ID.

Example

To set the scalar define ID:

hwi OpenStack
hwi GetActiveClientHandle client
set advQueryID [client AddAdvancedQuery]
client GetAdvancedQueryHandle advancedQuery_handle $advQueryID
advancedQuery_handle AddSimulations "current" "current"
advancedQuery_handle SetQuery "entity.id entity.value"
advancedQuery_handle SetScalarDefine 3
advancedQuery_handle SetQueryLogic "[rule_handle GetID]"
hwi CloseStack

Errors

This command returns HW_Error, if an invalid ID is passed to the argument ID.