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.
HyperGraph 2D
pltIVector Class
pltIVector GetSubcase
Gets the subcase for the vector.

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
    - HyperGraph 2D
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
        pltIVector AddDataAttribute
        Attaches a data attribute to the metadata of the datasource (vector).
        pltIVector Freeze
        Removes the dependency of this datasource (vector) from other datasources (vectors).
        pltIVector GetAssociatedAxis
        Gets the associated axis for the vector.
        pltIVector GetComponent
        Gets the component used by the vector.
        pltIVector GetDataAttributeHandle
        Gets a handle to a pltIAttribute interface for the specified attribute.
        pltIVector GetDataEndIndex
        Gets the end index of vector referenced by the datasource (vector).
        pltIVector GetDataIncrement
        Gets the increment of data vector referenced by the datasource (vector).
        pltIVector GetDataStartIndex
        Gets the start index of vector referenced by the datasource (vector).
        pltIVector GetDataType
        Gets the datatype used by the vector.
        pltIVector GetDependencyList
        Returns the dependency list for a datasource (vector).
        pltIVector GetExpression
        Gets the mathematical expression of the vector.
        pltIVector GetFilename
        Gets the filename of the data file referenced by the vector.
        pltIVector GetFrozen
        Gets whether the vector is frozen or unfrozen.
        pltIVector GetMathReference
        Gets the pwc reference for this curve.
        pltIVector GetMetaData
        Returns the metadata for the particular datasource (vector).
        pltIVector GetNumberOfDataAttributes
        Returns the number of attributes in the vector.
        pltIVector GetNumberOfColumns
        Returns the number of columns of the datasource (vector).
        pltIVector GetNumberOfRows
        Returns the number of rows of the datasource (vector).
        pltIVector GetOffset
        Gets the offset of the vector.
        pltIVector GetParameterizationID
        Gives the string corresponding the name and number of the datasource (vector).
        pltIVector GetRawValuesList
        Returns the raw data values for the datasource (vector).
        pltIVector GetReaderTargetVersion
        Returns the reader target version of the reader of the data file referenced by the datasource (vector).
        pltIVector GetScaleFactor
        Gets the scale factor of the vector.
        pltIVector GetSubcase
        Gets the subcase for the vector.
        pltIVector GetType
        Gets the type of the vector.
        pltIVector GetValuesList
        Gets the data values for the vector.
        pltIVector IsFrozen
        Returns whether the particular vector is independent of other vectors.
        pltIVector RemoveDataAttribute
        Removes the specified attribute from the vector.
        pltIVector SetAssociatedAxis
        Sets the associated axis for the vector.
        pltIVector SetComponent
        Sets the component used by the vector.
        pltIVector SetDataEndIndex
        Sets the end index of vector referenced by the datasource (vector).
        pltIVector SetDataIncrement
        Sets the increment of vector with given increment referenced by the datasource (vector).
        pltIVector SetDataStartIndex
        Sets the start index of data vector referenced by the datasource (vector).
        pltIVector SetDataType
        Sets the datatype used by the vector.
        pltIVector SetExpression
        Sets the mathematical expression of the vector.
        pltIVector SetFilename
        Sets the filename of the data file referenced by the vector.
        pltIVector SetFrozen
        Sets whether the vector is frozen or unfrozen.
        pltIVector SetMetaData
        Sets the metadata for the particular entity.
        pltIVector SetOffset
        Sets the offset of the vector.
        pltIVector SetReaderTargetVersion
        Sets the reader target version of the reader of the data file referenced by the datasource (vector).
        pltIVector SetRequest
        Sets the request used by the vector.
        pltIVector SetScaleFactor
        Sets the scale factor of the vector.
        pltIVector SetSubcase
        Sets the subcase for the vector.
        pltIVector SetType
        Sets the type of the vector.
        pltIVector SetValues
        Sets the data values of the vector.
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - pulIMacroParameter Class
    - 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.

pltIVector GetSubcase

Gets the subcase for the vector.

Syntax

pltIVector_handle GetSubcase

Application

Tcl Query

Description

This method is only valid for file vectors.

Values for subcase depend on the particular data file associated with the vector.

Returns the subcase used by the vector. This is an integer value.

Example

To get the subcase of the x vector of a curve:

MyCurve GetVectorHandle x myX
MyX GetSubcase

Errors

3 = HW_InvalidHandle - The handle used to invoke the method is no longer valid.