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
poIScalarDefine Class
poIScalarDefine SetEnvelopeTracingEntity
Sets the envelope tracing entity.

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
      - poIScalarDefine Class
        poIScalarDefine GetDataComponent
        Gets the data component of the result definition.
        poIScalarDefine GetAverageFactor
        Gets the nodal variation factor.
        poIScalarDefine GetAverageFactorEnabled
        Gets the nodal variation factor enabled state.
        poIScalarDefine GetAverageMode
        Gets the averaging mode.
        poIScalarDefine GetAverageModeList
        Gets the list of valid averaging modes.
        poIScalarDefine GetAvgAcrossPartsEnable
        Gets the average across parts enable state.
        poIScalarDefine GetComplexFilter
        Gets the complex filter.
        poIScalarDefine GetCornerDataEnabled
        Gets the use corner data state.
        poIScalarDefine GetDataComponent
        Gets the data component of the result definition.
        poIScalarDefine GetDataType
        Gets the data type of the result definition.
        poIScalarDefine GetEnvelopeTracingEntity
        Gets the envelope tracing entity.
        poIScalarDefine GetEnvelopeTracingEntityList
        Gets the envelope tracing entity list.
        poIScalarDefine GetFeatureAngleAverage
        Gets the feature angle average value.
        poIScalarDefine GetFeatureAngleAverageEnableState
        Gets the feature angle enable state.
        poIScalarDefine GetID
        Gets the ID of the scalar result definition.
        poIScalarDefine GetIgnoreFlippedNormal
        Gets the ignore flipped normal state.
        poIScalarDefine GetIsMultipleLayers
        Gets the multiple layers state.
        poIScalarDefine GetLabel
        Gets the label of the result definition.
        poIScalarDefine GetLayer
        Gets the layer of the result definition.
        poIScalarDefine GetLayerFilter
        Gets the layer filter of the result definition.
        poIScalarDefine GetLoaded
        Gets the loaded status of the result definition.
        poIScalarDefine GetMultipleLayerList
        Gets the currently selected list of multiple layers.
        poIScalarDefine GetProjectionRule
        Gets the projection axis information.
        poIScalarDefine GetResultSystem
        Gets the result system of the result definition.
        poIScalarDefine GetSelectionSetHandle
        Gets the poISelectionSet handle of the result definition.
        poIScalarDefine GetSelectionSetSize
        Gets the size of the selection set for a result definition for the specified model.
        poIScalarDefine GetShowMidsideNodeResults
        Gets the show midside node results state.
        poIScalarDefine GetType
        Gets the type of this result definition.
        poIScalarDefine GetValueFilter
        Gets the value filter values.
        poIScalarDefine GetValueFilterType
        Gets the value filter type.
        poIScalarDefine SetAverageFactor
        Sets the nodal variation factor. Specify the threshold variation level above which nodal averaging should not be carried out.
        poIScalarDefine SetAverageFactorEnabled
        Sets the nodal variation factor enabled state.
        poIScalarDefine SetAverageMode
        Sets the averaging mode.
        poIScalarDefine SetAvgAcrossPartsEnable
        Sets the average across parts enable state.
        poIScalarDefine SetComplexFilter
        Sets the complex filter.
        poIScalarDefine SetCornerDataEnabled
        Sets the use corner data state for a result definition.
        poIScalarDefine SetDataComponent
        Sets the data component of the result definition.
        poIScalarDefine SetDataType
        Sets the data type of the result definition.
        poIScalarDefine SetEnvelopeTracingEntity
        Sets the envelope tracing entity.
        poIScalarDefine SetFeatureAngleAverage
        Sets the feature angle average value.
        poIScalarDefine SetFeatureAngleAverageEnableState
        Sets the feature angle averaging enable state.
        poIScalarDefine SetIgnoreFlippedNormal
        Sets the ignore flipped normals enable state.
        poIScalarDefine SetIsMultipleLayers
        Sets the multiple layers state.
        poIScalarDefine SetLabel
        Sets the label of the result definition.
        poIScalarDefine SetLayer
        Sets the layer of the result definition.
        poIScalarDefine SetLayerFilter
        Sets the layer filter of the result definition.
        poIScalarDefine SetMultipleLayerList
        Sets the multiple layers list.
        poIScalarDefine SetMultipleLayers
        Sets the multiple layers state.
        poIScalarDefine SetProjectionRule
        Sets the projection axis information.
        poIScalarDefine SetResultSystem
        Sets the result system of the result definition.
        poIScalarDefine SetSelectionSet
        Sets the selection set with defines the entities of the result definition.
        poIScalarDefine SetShowMidsideNodeResults
        Sets the show midside node results state.
        poIScalarDefine SetValueFilter
        Sets the value filter values.
        poIScalarDefine SetValueFilterType
        Sets the value filter type.
      - 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

poIScalarDefine SetEnvelopeTracingEntity

Sets the envelope tracing entity.

Syntax

poIScalarDefine_handle SetEnvelopeTracingEntity entity

Application

HyperView Tcl Modify

Description

This command, valid only in HyperView - MultiCore profile, sets the envelope tracing entity for the result definition.

Note: The result definition can only be modified if it is not cached.

Inputs

entity: The envelope tracing entity value. This value must be one of the following: "none", "simulation" or "subcase"

Example

To set the envelope tracing entity for a result definition:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetResultHandle sdefine 4 scalar
sdefine SetEnvelopeTracingEntity subcase
hwi CloseStack

Errors

Returns an error code if there was an error setting the envelope tracing entity and sets error condition on the session handle. See session_handle GetError.

Related Topics

See the HyperView - MultiCore APIs topic for additional information regarding the various Tcl/Tk commands that have been added for this workflow.