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
poIResultCtrl Class
poIResultCtrl CancelResult
Cancels any pending tasks associated with a result 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
      - 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
        poIResultCtrl AddSubcase
        Adds a derived subcase to a result.
        poIResultCtrl AppendSimulation
        Adds a simulation reference to the current subcase.
        poIResultCtrl CacheResult
        Adds the currently plotted result to the internal cache.
        poIResultCtrl CancelLoading
        Cancels all loading associated with this result control.
        poIResultCtrl CancelResult
        Cancels any pending tasks associated with a result definition.
        poIResultCtrl ClearPlot
        Clears the plot of the specified result definition.
        poIResultCtrl ClearResult
        Removes the specified result from the internal cache.
        poIResultCtrl CreateLayerFilter
        Creates a layer filter.
        poIResultCtrl EraseSubcase
        Erases a derived subcase from a result.
        poIResultCtrl GetActiveIsoID
        Gets the result definition ID of the current iso plot.
        poIResultCtrl GetActiveResult
        Gets the ID of the currently plotted result definition of the specified type.
        poIResultCtrl GetCachedDataTypeList
        Gets a list of the ID-Name pairs for all of the cached data types.
        poIResultCtrl GetCollisionCtrlHandle
        Gets a handle to the collision control object.
        poIResultCtrl GetComplexCtrlHandle
        Gets a handle to the complex control object.
        poIResultCtrl GetContourCtrlHandle
        Gets a handle to the contour control.
        poIResultCtrl GetCurrentSimulation
        Gets the index of the current transient simulation.
        poIResultCtrl GetCurrentSubcase
        Gets the current subcase ID.
        poIResultCtrl GetDataComponentComplexFilter
        Returns whether or not a data component can be used with various complex filters for the specified subcase and data type.
        poIResultCtrl GetDataComponentList
        Gets a list of all data components from the result file for the specified subcase and data type.
        poIResultCtrl GetDataComponentTransformable
        Returns true if the component/derived type for the specified result allows system transformations.
        poIResultCtrl GetDataDimensionList
        Gets the list of dimensions with non-empty datasets. Values include: node, line, shell, or solid.
        poIResultCtrl GetDataTypeBinding
        Gets the binding for specified datatype return. Values include: node, element, or node_on_element.
        poIResultCtrl GetDataTypeFormat
        Gets the format for specified datatype return. Values include scalar, vector, and tensor.
        poIResultCtrl GetDataTypeList
        Gets a list with all data type labels from the result file for the specified subcase.
        poIResultCtrl GetDisplaySelectionHandle
        Gets the display selection set handle. Note that this is only supported in async HyperView.
        poIResultCtrl GetFLDCtrlHandle
        Gets a handle to the FLD control object.
        poIResultCtrl GetDataTypePoolList
        Gets a list of pools.
        poIResultCtrl GetIsoValueCtrlHandle
        Gets a handle to the iso value control object.
        poIResultCtrl GetLayerFilterHandle
        Gets the handle for a layer filter.
        poIResultCtrl GetLayerFilterList
        Gets the handle for a layer filter.
        poIResultCtrl GetLayerList
        Gets a list of shell layer labels from the result file for the specified subcase and data type.
        poIResultCtrl GetNumberOfDataComponents
        Gets the number of data components for the specified subcase and data type.
        poIResultCtrl GetNumberOfDataTypes
        Gets the number of data types in the result file for the specified subcase ID.
        poIResultCtrl GetNumberOfShellLayers
        Gets the number of shell layers for the specified subcase and datatype.
        poIResultCtrl GetNumberOfSimulations
        Gets the number of simulations for the specified subcase.
        poIResultCtrl GetNumberOfSubcases
        Gets the number of subcases in the result file.
        poIResultCtrl GetScaleCtrlHandle
        Gets a handle to the scale control object.
        poIResultCtrl GetShellLayerList
        Gets a list of shell layer labels from the result file for the specified subcase and data type.
        poIResultCtrl GetSimulationLabel
        Gets the simulation label.
        poIResultCtrl GetSimulationList
        Gets the list of simulation labels.
        poIResultCtrl GetSimulationLoaded
        Query whether the given simulation step is loaded.
        poIResultCtrl GetSubcaseLabel
        Gets the label of a given subcase.
        poIResultCtrl GetSubcaseList
        Gets the list of subcase IDs in the result file.
        poIResultCtrl GetSubcaseType
        Gets a label of a given subcase.
        poIResultCtrl GetTensorCtrlHandle
        Gets a handle to the tensor control object.
        poIResultCtrl GetVectorCtrlHandle
        Gets a handle to the vector control object.
        poIResultCtrl IsLayerFilterValid
        Checks if the layer filter is valid for the given data type.
        poIResultCtrl IsTrackable
        Utility function to find out the trackability of the specified data type.
        poIResultCtrl LoadResult
        Loads data for the specified result definition.
        poIResultCtrl LoadSimulation
        Loads position data (animation) for the given subcase and frame (index).
        poIResultCtrl PlotResult
        Plots the specified result definition.
        poIResultCtrl RemoveLayerFilter
        Removes the layer filter with the given ID.
        poIResultCtrl RemoveSimulation
        Removes the simulation reference from the current subcase.
        poIResultCtrl RestoreCachedPlot
        Restores the cached plot from the internal cache.
        poIResultCtrl SetCurrentSimulation
        Sets the current transient simulation.
        poIResultCtrl SetCurrentSubcase
        Sets the current subcase for result manipulation operations (for example: animation, contour, and vector plot).
        poIResultCtrl SetDisplaySelectionSet
        Assigns a selection set for a given context on the result ctrl handle to display the plot on entities in the set. Note that this is only supported in async HyperView.
        poIResultCtrl SetSubcaseLabel
        Sets the label of a derived subcase.
        poIResultCtrl UnloadResult
        Clears and unloads data for the specified result definition.
        poIResultCtrl UpdateResult
        Updates a result definition based on newly loaded steps.
        poIResultCtrl UnloadSimulation
        Frees memory associated with the given simulation index.
      - 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.

View All Altair HyperWorks Help

poIResultCtrl CancelResult

Cancels any pending tasks associated with a result definition.

Syntax

poIResultCtrl_handle CancelResult id context notify

Application

HyperView Tcl Modify

Description

This command, valid only in HyperView - MultiCore profile, cancels all future tasks, clears and unloads the specified result definition. Returns Success (0) if cancelling was successful or Warning (2) if there was a problem cancelling.

Inputs

id: The ID of the result definition to cancel.

context: A string indicating the context of the request. Valid values are: scalar, tensor, vector, and iso.
notify: Set to 'true' to trigger an event to update the browser, otherwise 'false'. The default value is true.

Example

To cancel loading the scalar result with ID 4:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle client
client GetModelHandle model [client GetActiveModel]
model GetResultCtrlHandle rc
rc CancelResult 4 scalar true
hwi CloseStack

Errors

Returns error code if there was an error in cancelling 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.