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.
Framework
hwIDataFile Class
hwIDataFile GetSubcase
Returns the name of the current subcase.

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
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
        hwIDataFile GetChannelMetaDataLabel
        Gets the label of an item of meta data associated with a file channel.
        hwIDataFile GetChannelMetaDataList
        Gets a list of meta data items associated with a file channel.
        hwIDataFile GetChannelMetaDataType
        Gets the type of an item of meta data associated with a file channel.
        hwIDataFile GetChannelMetaDataValue
        Gets an item of meta data associated with a channel of a file.
        hwIDataFile GetChannelValuesList
        Finds the data values in a specific channel.
        hwIDataFile GetComponentLabel
        Returns a string indicating the request’s label.
        hwIDataFile GetComponentList
        Returns a list of all components for a given data type.
        hwIDataFile GetDataTypeList
        Returns a list of all datatypes.
        hwIDataFile GetFilename
        Returns a string indicating the filename.
        hwIDataFile GetFilteredComponentList
        Returns a list of all components for a given data type and request.
        hwIDataFile GetHashValue
        Finds the hash value (sum of the structure of the file).
        hwIDataFile GetRequestLabel
        Returns a string indicating the request’s label.
        hwIDataFile GetRequestList
        Returns a list of all requests for a given datatype.
        hwIDataFile GetSubcase
        Returns the name of the current subcase.
        hwIDataFile GetSubcaseIDList
        Returns a list of the IDs of all subcases.
        hwIDataFile GetSubcaseList
        Returns a list of all subcases.
        hwIDataFile GetTimeChannelComponent
        Gets the component name of the time channel associated with a specified data channel.
        hwIDataFile GetTimeChannelDataType
        Gets the datatype name of the time channel associated with a specified data channel.
        hwIDataFile GetTimeChannelRequest
        Gets request name of the time channel associated with a specified data channel.
        hwIDataFile IsChannelMarked
        Gets the marked state of the given data channel.
        hwIDataFile IsFilePresent
        Finds whether the data file handle holds a file that exists.
        hwIDataFile IsValid
        Finds whether the data file handle holds a valid file.
        hwIDataFile MarkChannel
        Marks the given data channel.
        hwIDataFile ReadMarkedChannels
        Reads the marked data channels.
        hwIDataFile SetFilename
        Sets the current file in the data file handle.
        hwIDataFile SetSubcase
        Sets the current subcase.
        hwIDataFile UnmarkAllChannels
        Unmarks all data channels.
        hwIDataFile UnmarkChannel
        Unmarks the given data channel.
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - 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.

hwIDataFile GetSubcase

Returns the name of the current subcase.

Syntax

hwIDataFile_handle GetSubcase

Application

Tcl Query

Description

Returns the name of the current subcase.

hwIDataFile GetDataTypeList returns the list of data types for the current subcase only.

Inputs

datatypename: The name of the data type that is being queried. Requests vary by data type. For a list of datatypenames, use data_file_handle GetDataTypeList.
include_time (Optional): A filter that determines if Time is to be included as a request. This is not a normal request and defaults to false.

Example

To get the list of available subcases from a data file:

hwi GetSessionHandle mySessionName
mySessionName GetDataFileHandle myDataFile "indy.req"
myDataFile GetSubcaseList subcase_list
myDataFile SetSubcase "Displacement"
myDataFile GetSubcase
myDataFile GetDataTypeList type_list

Errors

None.