2023
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.
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following Altair HyperWorks applications.
View new features for version 2023.
Learn the basics and discover the workspace.
Discover product functionality with interactive tutorials.
Extensions are programs integrated with the application to enhance or extend the user experience.
Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
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 allows you perform a series of operations outside the program interface.
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.
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.
Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
Examples of script uses cases.
Learn more about Tcl/Tk with this basic example.
Learn more about programming with Tcl/Tk commands with this tutorial.
Adds an assembly using an existing data file.
Adds an assembly placeholder.
Adds an attachment to definition type entities (System, Analysis, Template, or Assembly).
Adds a new assembly from an existing or new data and definition file.
Adds a new definition type entity (System, Template, Dataset, Graphic system or Analysis).
Adds a system from an existing definition.
Adds a new system from an existing definition file.
Adds a new definition type entity.
Appends MDL statements to the System.
Obtains a list for a particular entity type and then later obtains a handle for one of its child objects.
Obtains the list of the entities present in the model based on the entity type specified.
Obtains the list of objects that reference 'the selected' object.
Cuts the object (which is another way of deleting an entity).
Deletes an object/entity.
Deletes one or multiple table entries.
Deselects an Assembly and converts it to an Assembly Placeholder.
Ends the BeginChildFastGet or BeginFlatListFastGet commands.
Creates and evaluates a temporary Templex template using the user-provided text.
Gets the list of attachment candidates which can be resolved to an attachment based on the attachment tag.
Gets the status if there is a change in Data or Definition.
Obtains the handle of the child object using its index value.
Gets the definition name of a definition type entity.
Gets the definition type of an Assembly.
Obtains the label of the child object.
Obtains the full variable of the child object.
Gets the global address from the specified local address.
Gets the list of the systems which are linked to particular system. Linked systems can be either DATA or DEFINITION linked.
Gets the local address from the specified global address.
Gets the number of child objects under a particular entity type.
Obtains the handle to an object.
Gets the handle of an entity using a known symbol (for example, variable name).
Gets back the parent handle from its child.
Gets the value from the 'selection_type' data member.
Obtains information about the source file for the assembly created in the model.
The state of an object depends upon three different states: “User State”, “Definable State”, and “If State”. You can only set the “User State” (the checkbox located in the upper right portion of every panel), the other two states are used by MotionView to automatically turn off certain items.
Gets the handle to the system from anywhere in the hierarchy (after the model handle).
Gets the entity/object type.
Retrieves the state of an object as set by the user in the checkbox (either checked or unchecked).
Obtains the variable of the child object.
Determines if a graphic under an object is highlighted or not.
Adds a new entity using the MDL statements keyword, variable name, and label.
Adds a new set statement to the system.
Determines if an object is an assembly or not.
Determines if the entity is a data member or not.
Determines whether or not the entity belongs to a DataSet.
Determines if the entity is a definition type or not.
Determines if two handles point to the same object.
Determines if the entity is a graphic entity.
Determines if an object is a half of a pair.
Determines if the object is implicitly defined (that is, it was not defined explicitly by the user).
Determines whether the object is included in the standard include file.
Determines if the selected entity is a model entity.
Determines if an object is a pair entity.
Determines whether or not an Assembly contains a data/definition file.
Determines whether an entity is a system or not.
Determines if the specified 'varname' is valid.
Highlights the outline of a graphic for visual identification of that particular graphic.
Pastes an object.
Replaces an existing assembly in the model with another assembly from the Suspension Library.
Replaces an existing entity with a new entity using the class variable name from the MDF file.
Replaces an existing entity with a new entity using MDL statement keywords and the remaining statement tokens.
Saves the model.
Saves the model to a specified file.
Saves the model to a specified location.
Saves the object.
Selects an existing data file for an Assembly Placeholder.
Sets the definition name of a definition type entity.
Sets the definition type of an Assembly or external Analysis.
Sets/changes the label of an object.
Sets the selection type of an Assembly or external Analysis.
Specifies a new location and file to which the current Data or Definition information will be saved to.
Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
XML commands in the Result Math Module.
Record playback workflows in the application.
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