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.
Templex and Math Reference Guide
Templex Reference
Templex is a general purpose text and numeric processor which generates output text based on guidelines defined in a template.
Templex Statements
List of Templex statements.
registerexternalfunction
Adds external math functions to a Templex template.

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.
- 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
  - Templex Reference
    Templex is a general purpose text and numeric processor which generates output text based on guidelines defined in a template.
    - About Templates
      A template is an ASCII text file containing plain text, Templex statements, mathematical expressions, constants, and variables that Templex processes.
    - Write Templates
      The syntax for Templex statements is similar to that of the C programming language.
    - Variables, Expressions and Formatting
      Learn about variables, expressions, and formatting using Templex.
    - Run Templex
      As well as using Templex from within MotionView and HyperGraph, Templex can also be run in batch mode from the command line of Unix operating systems.
    - Templex Statements
      List of Templex statements.
      - '
        Marks text as a comment.
      - abstorelative
        Changes the reference to a file from absolute (root directory) to relative. The relative path will be the difference between path_1 and path_2.
      - addfilepath
        Adds a path to the search path used by Templex.
      - append
        Appends an output file to the end of a specified file.
      - attach_note_at
        Specifies the point to which a note is attached.
      - attach_note_to
        Specifies the curve to which a note is attached.
      - automir
        Returns a mirror factor (either 1 or -1) that is value-dependent, either by position of the centroid or the position of the min/max values relative to the x axis.
      - close
        Terminates output to the currently open output file.
      - curval
        Returns a vector value at the current animation timestep.
      - curveedit
        Trim, bridge, cut, or replace curves within a given range.
      - define
        Defines macros, headers, and footers.
      - dictionary
        Creates a dictionary in Templex.
      - display_as_output
        Automatically processes templates, auto_templex_report.
      - echo
        Sends a string or mathematical expression to the standard error stream.
      - else
        Defines an additional execution path for an if block.
      - elseif
        Defines a conditional execution path for an if block.
      - enddefine
        Completes a macro definition.
      - endif
        Completes an if block.
      - endloop
        Completes a loop construct.
      - eval
        Evaluates the contents of a string as an expression.
      - exit
        Terminates the current template.
      - fileopen
        Opens the file specified by the path and also returns a handle to the file.
      - filereadstring
        Reads data from the file based on the expression.
      - for
        Begins a loop construct.
      - foreach
        Loops once for each element in an array or list.
      - format
        Specifies the default format for numeric output.
      - getcwd
        Returns the path for the current working directory. If you switch directories in the console or when loading files, the current working directory path will follow.
      - getvalueatindex
        Retrieves a value from a vector.
      - if
        Begins an if block.
      - include
        Calls a template from within the current template.
      - interpret_set
        Allows you to set a variable using Templex.
      - open
        Opens a new output file.
      - page
        Inserts a page break.
      - parameter
        Defines a DOE parameter.
      - path
        Adds a directory path to a path list for included files.
      - read
        Returns a vector from the specified data file.
      - readfill
        Specifies a fill file to be read by Templex.
      - readmac
        Given a reference mode in one result file, readmac searches for the best matched mode shape in a target file using model assurance criteria (MAC).
      - registerexternalfunction
        Adds external math functions to a Templex template.
      - registerexternalreader
        Adds an external reader to a Templex template for importing results data.
      - relativetoabs
        Changes the reference to a file from relative to absolute.
      - removefilepath
        Removes a path from the search path used by Templex.
      - report_animate
        Enables text animation for the text client.
      - rmax
        Returns a vector where the value for each index is the maximum value from the range of index 0 to this index.
      - safe_quotes_off
        Turns off safe quotes.
      - safe_quotes_on
        Turns on safe quotes.
      - set
        Assigns a value to a variable within a template.
      - sync2
        Synchronizes two different vectors.
      - sysarch
        Returns the platform that Templex is being run on.
      - system
        Issues a command to the operating system.
      - table
        Formats multiple arrays into columns.
      - templex_off
        Turns off Templex statement processing until a templex_on statement is encountered.
      - templex_on
        Turns on Templex processing.
      - undef
        Undefines macros and turns off headers and footers.
      - while
        Begins a loop construct.
  - Math Reference
    Mathematical functions and operators, including syntax, operators and specific information about each function.
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

registerexternalfunction

Adds external math functions to a Templex template.

Syntax

registerexternalfunction("alias", "path")

Input

"alias": The name assigned to the external program. Must be in double quotes.
"path": Full path and file name of executable.

Example

Template:

{registerexternalfunction("hic", "/usr/people/madhic")}

Comments

External programs can be registered for use with the math functions and operators. External programs must be registered in a template before they can be called using the extern math function.