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.
MotionView
mdlIModelClient Class
mdlIModelClient SetStandardIncludeFile
Sets the standard include file for the filename specified.

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
      - mdlIDataMember Class
      - mdlIFlexbody Class
      - mdlIModel Class
      - mdlIModelClient Class
        mdlIModelClient CheckModel
        Checks the model and assigns IDs to the model.
        mdlIModelClient CreateBlankModel
        Creates a blank model in the client whose handle is used.
        mdlIModelClient CreateModel
        Creates a model using the file specified.
        mdlIModelClient ExportModel
        Exports the model to the file name specified.
        mdlIModelClient ExportModelAnimationFile
        Exports the model related animation information to a given file.
        mdlIModelClient ForceDrawOfImplicitMarker
        Used to draw/display the implicit marker graphic of the selected marker.
        mdlIModelClient FreezeOutputIds
        Freezes the output IDs.
        mdlIModelClient GetCreateOption
        Gets the value of the option specified for creating a model.
        mdlIModelClient GetCurWizSettingProfile
        Retrieves your setting (profile) regarding where the wizard paths are specified.
        mdlIModelClient GetGlobalLightPosition
        Gets the position of the light.
        mdlIModelClient GetGlobalOption
        Gets a global option for all MotionView clients.
        mdlIModelClient GetImportOption
        Gets the current model import option.
        mdlIModelClient GetImportReaderInfoList
        Gets the list of currently registered solver readers.
        mdlIModelClient GetMdlFileStatsList
        Gets the details a file.
        mdlIModelClient GetModelHandle
        Gets the handle of the root node of the current model.
        mdlIModelClient GetObjectPickContextList
        Gets the list of objects that can be picked from the Graphic Window.
        mdlIModelClient GetObjectPickExceptionList
        Gets the list of objects that are an exception in the pick context list.
        mdlIModelClient GetObjectPickTypeList
        Gets the entity type (body, point, joint, etc.) that can currently be picked by clicking in the graphics area.
        mdlIModelClient GetPathList
        Gets the list of paths from the preference file statements.
        mdlIModelClient GetReportLogFile
        Gets the report .log file for a particular profile.
        mdlIModelClient GetRootObjectHandle
        Gets the handle of root node of the current model.
        mdlIModelClient GetSaveOption
        Gets the value for the given key. The key value can be set using the SetSaveOption command.
        mdlIModelClient GetSolverList
        Gets the list of the available solver mode variable names.
        mdlIModelClient GetSolverMode
        Gets the variable name of the current solver mode.
        mdlIModelClient GetSolverScript
        Gets the variable name of the current solver script.
        mdlIModelClient GetSolverScriptList
        Gets the list of the available solver scripts.
        mdlIModelClient GetStandardIncludeFile
        Gets the standard include file setting for the specified profile.
        mdlIModelClient GetTaskWizardFile
        Gets the task wizard file setting for the specified profile.
        mdlIModelClient GetUserModeLabelList
        Gets the list of labels of available user modes.
        mdlIModelClient GetUserModeVarnameList
        Gets the list of variable names of available user modes.
        mdlIModelClient GetWindowHandle
        Gets the handle of the window on which the client is opened.
        mdlIModelClient GetWizardLibDir
        Gets the directory that contains the files to create the wizard for the specified profile.
        mdlIModelClient ImportFile
        Imports the model from the file specified.
        mdlIModelClient IsDirty
        Evaluates whether the changes made in the model are saved or not.
        mdlIModelClient IsPickingEnabled
        Checks whether or not the picking of an entity from the graphics window is enabled.
        mdlIModelClient MakeClean
        Makes the client clean.
        mdlIModelClient MakeDirty
        Makes the client dirty.
        mdlIModelClient PostMessageToLog
        Displays text in the message log.
        mdlIModelClient RunSolverScript
        Runs a solver script.
        mdlIModelClient SaveModel
        Saves the model to a file as mdl data.
        mdlIModelClient SetAssemblyWizardFile
        Sets the model wizard file which will be used while creating an assembly model.
        mdlIModelClient SetCreateOption
        Sets the value of the option specified for creating a model.
        mdlIModelClient SetCurrentUserModeIdx
        Sets the user_mode argument as the user mode. “User mode” is the set of customized of icons listed in the toolbar (user_mode).
        mdlIModelClient SetCurWizSettingProfile
        Sets the current wizard setting profile.
        mdlIModelClient SetGlobalLightPosition
        Sets the position of the light.
        mdlIModelClient SetGlobalOption
        Sets a global option for all MotionView clients.
        mdlIModelClient SetImportOption
        Sets the import option.
        mdlIModelClient SetObjectPickContextList
        Sets the list of objects that can be picked from the Graphic Window.
        mdlIModelClient SetObjectPickExceptionList
        Sets the list of objects that are an exception to the objects that can be picked from the Graphic Window.
        mdlIModelClient SetObjectPickTypeList
        Sets the list of entity types that can be picked from the Graphic Window.
        mdlIModelClient SetOutlineGraphicWidth
        Sets the outline graphic width.
        mdlIModelClient SetReportLogFile
        Sets the report .log file.
        mdlIModelClient SetSaveOption
        Sets the value of the option specified for saving a model.
        mdlIModelClient SetSolverMode
        Sets the name of the current solver mode variable name.
        mdlIModelClient SetSolverScript
        Sets the name of the current solver script variable name.
        mdlIModelClient SetStandardIncludeFile
        Sets the standard include file for the filename specified.
        mdlIModelClient SetTaskWizardFile
        Sets the task wizard file for the specified profile.
        mdlIModelClient SetWizardLibDir
        Sets the directory that contains the files to create the wizard for the specified profile.
        mdlIModelClient SuppressMessages
        Suppresses messages into the Message Log.
        mdlIModelClient UpdateObjectInBrowser
        Updates the entity info (if it is present) in the browser and updates the corresponding views.
      - mdlIObject Class
      - ::model Procedures
    - HyperView
    - HyperGraph 2D
    - 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.

View All Altair HyperWorks Help

mdlIModelClient SetStandardIncludeFile

Sets the standard include file for the filename specified.

Syntax

mdlIModelClient_Handle SetStandardIncludeFile filename, arg_Profile

Application

MotionView Tcl Modify

Description

This command sets the standard include file for the filename specified.

Inputs

filename

The filename of the standard include file for the specified profile.

arg_Profile

Valid arguments are:

User: Settings specified for the user profile
Pref: Settings specified in the preference file

Example

Copy the standard include file into the present working directory, rename it as file_standard, and run the example below:

hwi OpenStack
hwi GetSessionHandle sess1
sess1 GetProjectHandle pro1
pro1 GetPageHandle pa1 [pro1 GetActivePage]
pa1 GetWindowHandle win1 [pa1 GetActiveWindow]
win1 GetClientHandle mcl
mcl SetStandardIncludeFile file_standard User
mcl ReleaseHandle;
win1 ReleaseHandle;
pa1 ReleaseHandle;
pro1 ReleaseHandle;
sess1 ReleaseHandle;
hwi CloseStack;

Errors

Returns 0 if successful.