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.
HyperGraph 2D
pltIExportCtrl Class
pltIExportCtrl SetFormat
Sets the format of the export file.

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
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
        pltIExportCtrl Export
        Exports an export file.
        pltIExportCtrl GetFilename
        Finds the name of a file.
        pltIExportCtrl GetFormat
        Finds the format type of the exported file.
        pltIExportCtrl GetFormatExtension
        Finds the extension for the user input format.
        pltIExportCtrl GetFormatList
        Gets the format list.
        pltIExportCtrl GetFromPage
        Finds the starting page of the session that the export file starts with.
        pltIExportCtrl GetSource
        Finds the source that is being used in the export.
        pltIExportCtrl GetToPage
        Finds the end page of the session that the export file contains.
        pltIExportCtrl SetFilename
        Sets the name of a file.
        pltIExportCtrl SetFormat
        Sets the format of the export file.
        pltIExportCtrl SetPageRange
        Sets the range of pages from the session that is to be exported.
        pltIExportCtrl SetSource
        Sets the source type that is being used in the export.
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - pulIMacroParameter Class
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - 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.

pltIExportCtrl SetFormat

Sets the format of the export file.

Syntax

pltIMacro_handle SetFormat format

Application

Tcl Modify

Description

This command sets the type of format that is to be used when the file is exported.

Inputs

format: The type of format that you want to set for the export file. The different types include: Excel, Column, XY Data, X GRAPH, Summary, Adams Spline, Altair Binary, CSV Blocks, DAC, RPC, and Excel Europe. These types can also be found by calling the GetFormatList function.

Example

hwi GetSessionHandle sess;
sess GetClientManagerHandle pm Plot;
pm GetMacroHandle mh 1;
mh GetExportCtrlHandle ex;
ex SetFormat "XY Data";

Errors

Success (0) or an error message is returned.

Keywords

Tcl

Export

Modify