API, Reference Guides

2023

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
poISubcase Class

What's New
Get Started
Tutorials
API, Reference Guides

2023

API, Reference Guides

What's New
View new features for version 2023.
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.
- 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
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
        
        poISubcase AppendSimulation
        Appends a simulation to a derived subcase.
        
        poISubcase AppendSubcase
        Appends a subcase to a derived subcase.
        
        poISubcase GetCurrentSimulation
        Gets the current simulation index of the subcase.
        
        poISubcase GetDataComponentComplexFilter
        Returns whether or not the data component can be used with various complex filters.
        
        poISubcase GetDataComponentList
        Returns the data component list for the data type requested.
        
        poISubcase GetDataComponentTransformable
        Returns whether or not the data component is transformable.
        
        poISubcase GetDataTypeBinding
        Returns the binding type of the data type specified.
        
        poISubcase GetDataTypeFormat
        Returns the format of the data type specified.
        
        poISubcase GetDataTypeList
        Returns a list containing all of the data types available in the subcase.
        
        poISubcase GetDerivedFunction
        Returns the function type of an envelope derived subcase.
        
        poISubcase GetDerivedFunctionList
        Returns the function type list for an envelope derived subcase.
        
        poISubcase GetDerivedSimulationIndex
        Returns the index of the simulation in the original subcase which was used to create this particular simulation (simidx) of the derived subcase.
        
        poISubcase GetDerivedSimulationLabel
        Returns the derived label of the simulation of a derived subcase.
        
        poISubcase GetDerivedSimulationList
        Returns a list containing the labels of all the derived simulations.
        
        poISubcase GetDerivedSimulationResultID
        Gets the result file ID corresponding to the simulation of a derived subcase.
        
        poISubcase GetDerivedSimulationSubcase
        Returns the ID of the original subcase which was used to create this particular simulation of the derived subcase.
        
        poISubcase GetDerivedType
        Returns the type of the derived subcase.
        
        poISubcase GetDerivedTypeList
        Returns the list of possible types for the derived subcase.
        
        poISubcase GetID
        Returns the ID of the subcase.
        
        poISubcase GetLabel
        Returns the label of the subcase.
        
        poISubcase GetLayerList
        Returns the layer list for the specified data type.
        
        poISubcase GetNumberOfDataComponents
        Returns the number of data components for a particular data type.
        
        poISubcase GetNumberOfDataTypes
        Returns the number of data types available in the subcase.
        
        poISubcase GetNumberOfDerivedSimulations
        Returns the number of derived simulations available in the derived subcase.
        
        poISubcase GetNumberOfSimulations
        Returns the number of simulations available in the subcase.
        
        poISubcase GetSimulationLabel
        Returns the simulation label corresponding to the index.
        
        poISubcase GetSimulationList
        Returns a list containing all of the simulation labels in the subcase.
        
        poISubcase GetSimulationScaleFactor
        Returns the scale factor for a particular simulation index.
        
        poISubcase GetSyncValue
        Returns the simulation sync value corresponding to the passed index.
        
        poISubcase GetType
        Returns the type of the subcase.
        
        poISubcase RemoveSimulation
        Removes a simulation from a derived subcase.
        
        poISubcase SetDerivedFunction
        Returns the function type of an "envelope" derived subcase.
        
        poISubcase SetDerivedType
        Sets the type for a derived subcase.
        
        poISubcase SetLabel
        Sets the label for a derived subcase.
        
        poISubcase UnloadSimulation
        Unloads the simulation corresponding to the index.
      - 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
- 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

API, Reference Guides

2023

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
poISubcase Class

What's New
Get Started
Tutorials
API, Reference Guides

poISubcase Class

Note: See the Derived Load Cases topic in the HyperView User's Guide for additional information.

poISubcase AppendSimulation
Appends a simulation to a derived subcase.
poISubcase AppendSubcase
Appends a subcase to a derived subcase.
poISubcase GetCurrentSimulation
Gets the current simulation index of the subcase.
poISubcase GetDataComponentComplexFilter
Returns whether or not the data component can be used with various complex filters.
poISubcase GetDataComponentList
Returns the data component list for the data type requested.
poISubcase GetDataComponentTransformable
Returns whether or not the data component is transformable.
poISubcase GetDataTypeBinding
Returns the binding type of the data type specified.
poISubcase GetDataTypeFormat
Returns the format of the data type specified.
poISubcase GetDataTypeList
Returns a list containing all of the data types available in the subcase.
poISubcase GetDerivedFunction
Returns the function type of an envelope derived subcase.
poISubcase GetDerivedFunctionList
Returns the function type list for an envelope derived subcase.
poISubcase GetDerivedSimulationIndex
Returns the index of the simulation in the original subcase which was used to create this particular simulation (simidx) of the derived subcase.
poISubcase GetDerivedSimulationLabel
Returns the derived label of the simulation of a derived subcase.
poISubcase GetDerivedSimulationList
Returns a list containing the labels of all the derived simulations.
poISubcase GetDerivedSimulationResultID
Gets the result file ID corresponding to the simulation of a derived subcase.
poISubcase GetDerivedSimulationSubcase
Returns the ID of the original subcase which was used to create this particular simulation of the derived subcase.
poISubcase GetDerivedType
Returns the type of the derived subcase.
poISubcase GetDerivedTypeList
Returns the list of possible types for the derived subcase.
poISubcase GetID
Returns the ID of the subcase.
poISubcase GetLabel
Returns the label of the subcase.
poISubcase GetLayerList
Returns the layer list for the specified data type.
poISubcase GetNumberOfDataComponents
Returns the number of data components for a particular data type.
poISubcase GetNumberOfDataTypes
Returns the number of data types available in the subcase.
poISubcase GetNumberOfDerivedSimulations
Returns the number of derived simulations available in the derived subcase.
poISubcase GetNumberOfSimulations
Returns the number of simulations available in the subcase.
poISubcase GetSimulationLabel
Returns the simulation label corresponding to the index.
poISubcase GetSimulationList
Returns a list containing all of the simulation labels in the subcase.
poISubcase GetSimulationScaleFactor
Returns the scale factor for a particular simulation index.
poISubcase GetSyncValue
Returns the simulation sync value corresponding to the passed index.
poISubcase GetType
Returns the type of the subcase.
poISubcase RemoveSimulation
Removes a simulation from a derived subcase.
poISubcase SetDerivedFunction
Returns the function type of an "envelope" derived subcase.
poISubcase SetDerivedType
Sets the type for a derived subcase.
poISubcase SetLabel
Sets the label for a derived subcase.
poISubcase UnloadSimulation
Unloads the simulation corresponding to the index.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent