HyperWorks Desktop

2021.2

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperView
poIResultCtrl Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2021.2

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.2.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Create, open, import, and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
- HyperWorks Desktop
  - 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.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, 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 HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
      - MotionView
      - HyperView
        
        Hotspot Finder API Structure
        
        Upfront Data Loader 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
        
        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
  - 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.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- 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 Simulation Help

HyperWorks Desktop

2021.2

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperView
poIResultCtrl Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

poIResultCtrl Class

Note: See the Results topic in the HyperView User's Guide for additional information.

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.

(c) 2021. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support