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 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.
Labels and Annotations
An Altair Binary Format file can include labels and annotations that contain additional information.
ABF Statements
abfCloseRequest()
Closes the currently open request.

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.
  - Altair Binary Format Organization
    ABF is organized according to a three-tier system. The format consists of two parts, the header and the data.
  - Import Templates and External Readers
    The program reads a variety of ASCII and binary formats and have a template-based system that allows you to read formats which are not supported internally. This template-based system uses a language called Import.
  - ABF File Format
    ABF and the program use a three-tier system comprised of datatypes, requests, and components. A file that does not contain three tiers cannot be translated into Altair Binary Format unless it is restructured into three tiers.
  - Create and Open the ABF File
    The ABF library is used to write to Altair Binary Format files. Before you can write to an ABF file, it must first be initialized. Once the file is initialized, you can create and open the file. When you write to an ABF file, the existing file is overwritten without warning.
  - Create Data Structures
    Once an Altair Binary Format file is created and opened, the structure of the data contained within the file must be specified. The data structure and the data can be specified in one step or the data can be entered after the data structure is specified.
  - Specify Numeric Precision
    In Altair Binary Format files, data is stored at the component level. The default data format is eight-byte floating point values.
  - ABF File Data Output
    Once the data structure and data for each component have been specified, the ABF library can output the ABF file.
  - Delayed Data Transfer
    An external reader is usually called several times while importing data. This process allows you to specify what file information you want to access.
  - Labels and Annotations
    An Altair Binary Format file can include labels and annotations that contain additional information.
    - ABF Statements
      - abfAddInteger()
        Appends an integer value to the currently open component.
      - abfAddIntegers()
        Appends a series of integer values to the currently open component.
      - abfAddReal()
        Appends an integer value to the currently open component.
      - abfAddReals()
        Appends a series of floating point values to the currently open component.
      - abfAnnotateFile()
        Attaches a comment to the currently open ABF file.
      - abfAnnotateRequest()
        Associates ASCII text with the currently open request.
      - abfCalloc()
        Allocates a block of memory.
      - abfCloseComponent()
        Closes the currently open component.
      - abfCloseDatatype()
        Closes the currently open datatype.
      - abfCloseFile()
        Closes the currently open ABF file.
      - abfCloseRequest()
        Closes the currently open request.
      - abfCommandLine()
        Indicates whether a particular component was requested by the program.
      - abfDefaultPrecision()
        Indicates the default precision of the values in the currently open ABF file.
      - abfDefineComponent()
        Defines the numeric contents of a component via an expression.
      - abfDelayed()
        Checks to see if any data was requested from the translator.
      - abfDeleteComponent()
        Removes an existing component from the currently open datatype.
      - abfDeleteDatatype()
        Removes an existing datatype from the currently open ABF file.
      - abfDeleteFile()
        Deletes an existing ABF file.
      - abfDeleteRequest()
        Removes an existing request from the currently open datatype.
      - abfEmptyComponent()
        Specifies the component to empty.
      - abfEmptyCurrentComponent()
        Empties the currently opened component.
      - abfError()
        Changes the ABF file header to reflect that an error occurred in translation (making the file unreadable) and imbeds a message in the file which is displayed in the message log.
      - abfFailure()
        Changes the ABF file header to reflect that an error occurred in translation (making the file unreadable) and imbeds a message in the file which is displayed in the program's message log.
      - abfGetComponentName()
        Returns the name of the currently open component.
      - abfGetDatatypeName()
        Returns the name of the currently open datatype.
      - abfGetFileName()
        Opens an ABF file.
      - abfGetInputFile()
        Returns the path of the input file given to the reader.
      - abfGetReaderTargetVersion()
        Returns the version passed to the reader by HyperGraph. This is the version of HyperGraph that the reader should try to match itself to.
      - abfGetRequestName()
        Returns the name of the currently open request.
      - abfInit()
        Initializes the ABF library.
      - abfLabelComponent()
        Associates a secondary identifier or label with the currently open component.
      - abfLabelDatatype()
        Associates a secondary identifier or label with the currently open datatype.
      - abfLabelRequest()
        Associates a secondary identifier or label with the currently open request.
      - abfMessage()
        Adds a message to the ABF file which is displayed in the message log.
      - abfNewComponent()
        Adds a new component (data sub-field) to the currently open datatype.
      - abfNewDatatype()
        Adds a new datatype to the currently open datatype.
      - abfNewFile()
        Creates an empty ABF file.
      - abfNewRequest()
        Adds a new request (data field) to the currently open datatype.
      - abfOpenComponent()
        Opens an existing component in the currently open request.
      - abfOpenComponentByIndex()
        Opens an existing component in the currently open request.
      - abfOpenDatatype()
        Opens an existing datatype in the currently open ABF file.
      - abfOpenDatatypeByIndex()
        Opens an existing datatype in the currently open ABF file.
      - abfOpenFile()
        Opens an ABF file.
      - abfOpenRequest()
        Opens an existing request in the currently open datatype.
      - abfOpenRequestByIndex()
        Opens an existing request in the currently open datatype.
      - abfRegisterIndex()
        Marks the currently open datatype as representing time.
      - abfRegisterTime()
        Marks the currently open datatype as representing time.
      - abfRequested()
        Indicates whether a particular component was requested by the program.
      - abfSetComponentBuffer()
        Transfers an entire range of values.
      - abfSetComponentTime()
        Creates a file with associations to multiple frequency channels.
      - abfSetPrecision()
        Indicates the precision of the values in the currently open component.
      - abfTimeString()
        Creates a file with associations to multiple frequency channels.
      - abfUseFloatingPoint()
        Indicates whether the currently open component contains integer or floating-point data.
      - abfVersion()
        Indicates whether a particular component was requested by the program.
      - abfVersionString()
        Specifies a string which describes the version of the translator.
      - abfWarning()
        Adds a warning to the ABF file which is displayed in the message log.
      - abfWriteHeader()
        Outputs the ABF header, which contains information on the structure and content of the file.
      - abfWriteHeaderAndData()
        Outputs the ABF header, which contains information on the structure and content of the file, and the data itself.
  - Specify Component Data with Expressions
    When a data component can be expressed in terms of another, it is unnecessary to include the full set of values for both.
- 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
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

abfCloseRequest()

Closes the currently open request.

Syntax

void abfCloseRequest();

Example

abfCloseRequest();

Comments

There must not be an open component when this function is called.