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.
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.
Import Templates
Import templates are files that contain instructions for reading plot data files.
Import Statements
int
Declares an integer variable.

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.
  - External Resources for Preference Files
  - External Resources for Session Files
  - External Resources for Templex Files
  - Import Templates
    Import templates are files that contain instructions for reading plot data files.
    - Import Language
      Import is an interpretive computer language designed specifically to create templates for reading plottable data files, such as XY data or time-histories. It is not a general purpose language, like C or BASIC. Import focuses on reading data files in the fastest most reliable manner.
    - Import Template Structure
      Each template typically consists of four sections or blocks.
    - Read Import Data
      Import templates are based on sequential access. All commands that read information, with the exception of integer variables, transfer data into a list or an array.
    - Data Flow Control
      Import contains provisions for jumping ahead in a file and then backing up (using rewind).
    - Errors and Error Handling
      Many import commands can result in a failure condition. This means that the template cannot complete the execution of a command in a meaningful fashion.
    - Conditional Execution
      The only time that a failure condition does not terminate execution is if it occurs in an if block.
    - Loops
      Besides conditional execution, Import also supports iteration.
    - Variables and Integer Math
      Integer variables can be declared anywhere in the global block of a template by using the int directive.
    - MADYMO Example
    - ADAMS Example
    - Import Statements
      - //
        Marks the beginning of a comment.
      - {
        Begins program block.
      - }
        Terminates a program block.
      - =
        Sets the variable to the left of the "=" to the value of the expression on the right.
      - assume
        Indicates that the following assumption can be made about a file format.
      - ccount
        Counts the occurrences of one character in a data file before the next occurrence of a terminal character.
      - compname
        A reserved variable which holds a list of the component names.
      - component
        A reserved variable holding the list of component values for the current request.
      - components
        Specifies the names of one or more components.
      - count
        Counts the number of lines containing an occurrence of one regular expression in a file before another regular expression is encountered.
      - demangle
        Sets a protocol for reversing the mangling process on requests.
      - do
        Initiates a loop.
      - else
        Executes the following program block only if the last if statement returned false; that is, failed.
      - explicit
        Declares the presence of an expected feature in the file; that is, time values.
      - fileext
        Compares the filename extension of the data file to a string.
      - filename
        Compares the name of the current data file to a regular expression.
      - find
        Searches the current data file until a regular expression is encountered.
      - header
        Marks the beginning of first block of the template.
      - if
        Stores the outcome of the following program block for determining the execution of program branches later on.
      - int
        Declares an integer variable.
      - isalpha
        Tests the next character in the input stream to see if it is alphabetic.
      - isdigit
        Tests the next character in the input stream to see if it is a digit.
      - linear
        Indicates that each request in the file is contained on one and only one line.
      - long
        Declares that the distinction between long and short request names is valid.
      - longname
        A reserved variable which holds a list of the long request names.
      - magnitude
        Takes the magnitude of a three dimensional vector.
      - mangle
        Combine several strings to specify the names of one or more requests.
      - mark
        Records the current file position.
      - mark2
        Records the secondary file position.
      - maxfind
        Reserved variable holding the maximum number of lines to search.
      - names
        Declares that the distinction between long and short request names is valid.
      - null
        Causes the results of the current input operation to be ignored.
      - numcomponents
        A predefined variable which holds the number of components in a file.
      - numrecords
        A predefined variable which holds the number of records in a file.
      - numrequests
        A predefined variable which holds the number of requests in a file.
      - precision
        A predefined variable which defines the number of decimal places used when reading floating point values.
      - print
        Sends a message to the message log.
      - qcount
        Counts the number of lines containing an occurrence of one regular expression in a file before another regular expression is encountered.
      - qfind
        Searches the current data file until a string is encountered.
      - read
        Reads an integer, floating point number or short string (one word or token).
      - readln
        Reads an integer, floating point number, or string.
      - record
        Marks the start of the program block which handles the reading of each record from the file.
      - request
        A reserved variable holding the list of request values for the current record.
      - requests
        Specifies the names of one or more requests.
      - rewind
        Return the file to the last position marked.
      - rewind2
        Return the file to the last secondary position marked.
      - set
        Sets an integer variable to the value of a constant, variable or simple function.
      - shortname
        List of short request names.
      - start
        Mark the beginning of the data to be read.
      - strict
        Causes the read or readln statement to compare a string read from the data file to a regular expression.
      - sum
        Takes the sum of two integer values.
      - then
        Indicates that the following block should be executed if the result of the last if statement was true.
      - time
        Directs a read statement to assume that the next request in the file contains only one component; that is, it’s time-like).
      - type
        Sets the default data type for a file format.
      - types
        Sets the data types of one or more requests.
      - units
        Specifies the number of time units per second.
      - until
        Truncates a line read by the readln command.
  - Export Templates
    Export templates are Templex programs that export curve data to files.
  - External Functions - Altair IPC
    You can create external programs for processing plot data in the program using the C programming language. Altair IPC, or inter-process communication, allows you to exchange data between the Altair program and an external program.
- 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.
- 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.

int

Declares an integer variable.

Syntax

int varname

Comments

varname can contain upper and lower case and numerals.

Integer variables may be declared only in the global part of the template code.

Example

int Apples
int items2read