API, Reference Guides

2023

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.
HyperMesh
Solver Templates
Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
Commands and Functions
Card Previewer Commands
*endcardmenu()
Indicates the end of the Control Cards list.

What's New
Get Started
Tutorials
API, Reference Guides

2023

API, Reference Guides

What's New
View new features for version 2023.
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.
- 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
- HyperMesh
  - API Programmer's Guides
    These provide an overview of all additions, updates, and changes to the HyperMesh APIs for each release.
  - Data Names
    Details on the core data that can be queried and manipulated.
  - Ext API
    This API allows external applications to link HyperMesh as a library and provides a limited set of functions and structures to access specific functionality.
  - FE Input Readers
    FE input readers are C programs that read information from ASCII or binary finite element models files into the HyperMesh database.
  - HMASCII
    Details on the HMASCII format and associated commands.
  - Scripts
    This section contains details on general HyperWorks scripting concepts, along with documentation on the Tcl commands that can be used to query and modify the database and GUI.
  - Solver Templates
    Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
    - Card Previewer
      The HyperMesh Card Image panel is used to define solver specific data and review card information. The format of the cards and the menus in the panel are defined in the export template, using HyperMesh Card Preview Commands.
    - Create Solver Templates
    - Commands and Functions
      - Card Previewer Commands
        
        *begincardmenu()
        Indicates the beginning of the Control Cards list.
        
        *beginmenu()
        Indicates the beginning of the description used for the card previewer.
        
        *beginrepeat()
        Repeats execution of a block of code a specified number of times.
        
        *beginrepeat2d()
        Repeats execution of a block of code a specified number of times.
        
        *cardmenuitem()
        Specifies the name and tag attribute for a Control Card.
        
        *endcardmenu()
        Indicates the end of the Control Cards list.
        
        *endmenu()
        Indicates the ending of the description used for the card previewer.
        
        *endrepeat()
        Terminates the code block to be executed by *beginrepeat().
        
        *endrepeat2d()
        Terminates the code block to be executed by *beginrepeat2d().
        
        *enumeration()
        Creates an enumeration.
        
        *globaldefaults()
        Used to specify that each real, integer, and string attribute is modified as per the *menudefaultvalue().
        
        *menuattributecreate()
        Initializes an attribute to a specified value upon creation of an entity.
        
        *menuattributeset()
        Sets the value of attribute.
        
        *menucase()
        The *menucase() command specifies a block of card image template commands that are executed when an attribute has the value matching the *menucase() command.
        
        *menucounterset()
        Sets the value of the local counter.
        
        *menudefaultvalue()
        Modifies an attribute field so that it has an on/off status.
        
        *menuelse()
        Used to define the false block of a *menuif() statement.
        
        *menuendif()
        Used to define the end of an *menuif() block.
        
        *menuentitysubtype()
        Modifies an attribute field so that the contents of the selection must be of the specified entity type in the HyperMesh database.
        
        *menuentitytype()
        Modifies an attribute field so that the selection must be an ID of an entity of a specified type in the HyperMesh database.
        
        *menuenum()
        Modifies an attribute field so that its value is displayed as and restricted to an enumeration's values.
        
        *menufield()
        Places a formatted value from the database into the card image.
        
        *menuif()
        Used to conditionally execute branches in the card image.
        
        *menuinitialarrayvalue()
        Sets the initial values of an attribute.
        
        *menuinitialvalue()
        Sets the initial value of an attribute if the attribute does not currently exist on the entity.
        
        *menulegalvalue()
        Modifies an attribute field so that a selection must be made from a list.
        
        *menulineend()
        Ends the current line in the card image.
        
        *menuoption()
        Specifies that the value of an attribute can only be 0 or 1.
        
        *menuoptionend()
        Terminates a *menuoption() or *menuoptionenum() command.
        
        *menuoptionenum()
        Specifies that the value of an attribute is defined by a previously defined *enumeration() command.
        
        *menupointerset()
        Sets the initial value of a pointer.
        
        *menurestrictedvalue()
        Modifies an attribute field so that it alerts you when a value is outside of a specified range.
        
        *menustring()
        Displays a string in the card image.
        
        *menuvariableset()
        Sets a variable to a specific value.
        
        *nomenu()
        Specifies that the card image definition is in a following block.
        
        *repeatcounter()
        Specifies a counter to store the current repeat value for a *beginrepeat() or *beginrepeat2d() command.
        
        *repeatwrap()
        Sets the right margin so that no field goes beyond in a *beginrepeat()/*endrepeat() block.
        
        Undocumented Card Previewer Commands
        The list of undocumented card previewer commands.
      - Solver Template Commands
      - Solver Template Functions
- 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.

View All Altair HyperWorks Help

API, Reference Guides

2023

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.
HyperMesh
Solver Templates
Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
Commands and Functions
Card Previewer Commands
*endcardmenu()
Indicates the end of the Control Cards list.

What's New
Get Started
Tutorials
API, Reference Guides

*endcardmenu()

Indicates the end of the Control Cards list.

Syntax

*endcardmenu ()

Type

HyperMesh Card Previewer Command

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent