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.
HgTrans
HgTrans Control Class
hgtrans control GetIncrement
Gets the current increment between data points to be translated.

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
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
      - HgTrans Config Class
      - HgTrans Control Class
        hgtrans control AddLabelAliasRule
        Sets an aliasing rule for channel labels.
        hgtrans control ClearLabelAliasRules
        Clears currently defined aliases.
        hgtrans control GetCompressionLevel
        Gets the current compression level for all data channels.
        hgtrans control GetConfigFile
        Gets the current configuration file name.
        hgtrans control GetEnd
        Gets the last data point index to be translated.
        hgtrans control GetFile
        Gets the current input file name.
        hgtrans control GetFileFilters
        Gets the list of filters associated with various supported formats.
        hgtrans control GetIncrement
        Gets the current increment between data points to be translated.
        hgtrans control GetLabelAliasPattern
        Gets the pattern associated with a previously defined alias.
        hgtrans control GetLabelAliasReplacement
        Gets the replacement string associated with a previously defined alias.
        hgtrans control GetMathFunctionList
        Gets the list of filters associated with various supported formats.
        hgtrans control GetNumberOfLabelAliasRules
        Gets the number of currently defined aliases.
        hgtrans control GetNumberOfMathFunctionParameters
        Gets the number of parameters required by a math function.
        hgtrans control GetOutputFile
        Gets the current output file name.
        hgtrans control GetReader
        Gets the current scale factor for all time channels.
        hgtrans control GetStart
        Gets the current starting data point index.
        hgtrans control GetTimeScaleFactor
        Gets the current scale factor for all time channels.
        hgtrans control SaveConfig
        Saves the current configuration to a file.
        hgtrans control SetCompressionLevel
        Sets the compression level for all data channels.
        hgtrans control SetConfigFile
        Sets the configuration file name.
        hgtrans control SetEnd
        Sets the last data point index to be translated.
        hgtrans control SetFile
        Sets the input file name.
        hgtrans control SetIncrement
        Sets the increment between data points translated.
        hgtrans control SetOutputFile
        Sets the output file name.
        hgtrans control SetStart
        Sets the starting data point index.
        hgtrans control SetTimeScaleFactor
        Sets the scale factor for all time channels.
        hgtrans control StartTranslation
        Begins the process of reading from the input file and writing selected channels to the output file.
      - HgTrans Result Class
    - 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.

hgtrans control GetIncrement

Gets the current increment between data points to be translated.

Syntax

Application

HyperGraphTrans Tcl Query

Description

This command gets the increment between data points read from each channel in the input file. Increments greater than one are primarily used to pair down large data sets.

Example

Set hgtrans to translate only every other data point, and then verify.

hgtrans control SetIncrement 2
hgtrans control GetIncrement

Errors

None.

Keywords

get increment