API, Reference Guides

2023.1

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.
HyperView
poIQueryCtrl Class

What's New
Get Started
Tutorials
API, Reference Guides

2023.1

API, Reference Guides

What's New
View new features for version 2023.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 HyperView and HyperGraph.
- 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
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
        
        poIQueryCtrl GetDataSourceFieldDescriptionList
        Gets a list of descriptions for the data fields for the specified data source.
        
        poIQueryCtrl GetDataSourceFieldList
        Gets a list of fields for the specified data source.
        
        poIQueryCtrl GetDataSourceFieldPairList
        Gets a list of data fields for the specified data source using the sourcename.fieldname format.
        
        poIQueryCtrl GetDataSourceList
        Gets a list of the available data sources.
        
        poIQueryCtrl GetDataSourceProperty
        Gets the value of the specified property for a given source.
        
        poIQueryCtrl GetDataSourcePropertyList
        Gets a list of properties for the specified data source.
        
        poIQueryCtrl GetError
        Gets the last occurred error description, or returns nothing.
        
        poIQueryCtrl GetIteratorHandle
        Creates and returns a handle to the QueryIterator object that allows you to iterate through query results.
        
        poIQueryCtrl GetQuery
        Gets a list of request fields in a query.
        
        poIQueryCtrl GetRemoveDuplicates
        Gets the state of the remove duplicates option.
        
        poIQueryCtrl GetSelectionSetSize
        Gets the size of the entities selection set that will be used to query the HyperView database.
        
        poIQueryCtrl SetDataSourceProperty
        Sets the new value for a specified property for a given data source.
        
        poIQueryCtrl SetQuery
        Sets the query string.
        
        poIQueryCtrl SetRemoveDuplicates
        Sets the state of the remove duplicates option in the query handle.
        
        poIQueryCtrl SetSelectionSet
        Sets the selection set of a query.
        
        poIQueryCtrl WriteData
        Writes the query results to the specified file in .csv format.
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - 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
- 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

API, Reference Guides

2023.1

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.
HyperView
poIQueryCtrl Class

What's New
Get Started
Tutorials
API, Reference Guides

poIQueryCtrl Class

Note: See the Query topic in the HyperView User's Guide for additional information.

poIQueryCtrl GetDataSourceFieldDescriptionList
Gets a list of descriptions for the data fields for the specified data source.
poIQueryCtrl GetDataSourceFieldList
Gets a list of fields for the specified data source.
poIQueryCtrl GetDataSourceFieldPairList
Gets a list of data fields for the specified data source using the sourcename.fieldname format.
poIQueryCtrl GetDataSourceList
Gets a list of the available data sources.
poIQueryCtrl GetDataSourceProperty
Gets the value of the specified property for a given source.
poIQueryCtrl GetDataSourcePropertyList
Gets a list of properties for the specified data source.
poIQueryCtrl GetError
Gets the last occurred error description, or returns nothing.
poIQueryCtrl GetIteratorHandle
Creates and returns a handle to the QueryIterator object that allows you to iterate through query results.
poIQueryCtrl GetQuery
Gets a list of request fields in a query.
poIQueryCtrl GetRemoveDuplicates
Gets the state of the remove duplicates option.
poIQueryCtrl GetSelectionSetSize
Gets the size of the entities selection set that will be used to query the HyperView database.
poIQueryCtrl SetDataSourceProperty
Sets the new value for a specified property for a given data source.
poIQueryCtrl SetQuery
Sets the query string.
poIQueryCtrl SetRemoveDuplicates
Sets the state of the remove duplicates option in the query handle.
poIQueryCtrl SetSelectionSet
Sets the selection set of a query.
poIQueryCtrl WriteData
Writes the query results to the specified file in .csv format.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent