User Guide

2022.3

Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Function Guide for Activate
Provides information about developing and simulating models through the Activate Application Program Interface.
Simulation APIs
Learn about the APIs available for simulating models.
Blocks

What's New
Get Started
Tutorials
User Guide
Reference Guides
Frequently Asked Questions

Index

2022.3

User Guide

What's New
Discover new features and enhancements.
Get Started
New to Activate? Learn the basics here.
Tutorials
Start using Activate with our interactive tutorials.
User Guide
Learn about the features and functionality available in Activate.
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
- Extended Definitions for Advanced Users
  PDF file with in-depth information on key topics in the User's Guide.
- Scripting Guide for OpenMatrix Language
  OpenMatrix is a mathematical scripting language.
- Reference Guide for OpenMatrix Language Functions
  The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
- Block Reference Guide
  Describes all of the blocks in the installed Activate library.
- Function Guide for Activate
  Provides information about developing and simulating models through the Activate Application Program Interface.
  - Block Diagram Editor APIs
    Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
  - Utility APIs
    Learn about the APIs available for obtaining information from Activate models, for example information about variables and environments.
  - Simulation APIs
    Learn about the APIs available for simulating models.
    - Start and Information
    - Settings
    - Blocks
      - vssLinearizeSuperBlock
        Perform linearization of Super Block.
      - vssGetInputData
        Get block's signal input.
      - vssGetOutputDataType
        Get output data type of a certain block
      - vssGetEventCode
        Get block's event.
      - vssSetOutputData
        Set block's signal output.
      - vssBlockInitializeFlag
        Flag used in custom blocks called at the start of a simulation to perform actions upon the initialization of the simulation, such as allocating memory, opening a file or a channel.
      - vssBlockReinitializeFlag
        Flag used in custom blocks mainly with continuous blocks for updating states based on a defined input. For example, the block can be called by the simulator during the initialization phase to find the steady state of a system.
      - vssBlockTerminateFlag
        Flag used in custom blocks and called only once at the end of a simulation if the block requires final tasks to be performed, such as clearing variables, exporting, or organizing information once the block execution has finished.
      - vssBlockOutputUpdateFlag
        Flag used in custom blocks and called to compute the outputs during a simulation. It is called every time the block is activated.
      - vssBlockDerivativeFlag
        Flag used in custom blocks and called to apply a specific computation to the system.
      - vssSetDerState
        Set the derivative state of a block.
      - vssGetState
        Get the state of a block.
      - vssGetOparData
        Get a given Object parameter that is defined in the Parameters tab.
    - Models
    - Built-in Variables
- Glossary
  Key terms associated with the software.
Frequently Asked Questions
You've got questions? We've got answers!

View All Altair Simulation Help

User Guide

2022.3

Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Function Guide for Activate
Provides information about developing and simulating models through the Activate Application Program Interface.
Simulation APIs
Learn about the APIs available for simulating models.
Blocks

What's New
Get Started
Tutorials
User Guide
Reference Guides
Frequently Asked Questions

Index

Blocks

vssLinearizeSuperBlock
Perform linearization of Super Block.
vssGetInputData
Get block's signal input.
vssGetOutputDataType
Get output data type of a certain block
vssGetEventCode
Get block's event.
vssSetOutputData
Set block's signal output.
vssBlockInitializeFlag
Flag used in custom blocks called at the start of a simulation to perform actions upon the initialization of the simulation, such as allocating memory, opening a file or a channel.
vssBlockReinitializeFlag
Flag used in custom blocks mainly with continuous blocks for updating states based on a defined input. For example, the block can be called by the simulator during the initialization phase to find the steady state of a system.
vssBlockTerminateFlag
Flag used in custom blocks and called only once at the end of a simulation if the block requires final tasks to be performed, such as clearing variables, exporting, or organizing information once the block execution has finished.
vssBlockOutputUpdateFlag
Flag used in custom blocks and called to compute the outputs during a simulation. It is called every time the block is activated.
vssBlockDerivativeFlag
Flag used in custom blocks and called to apply a specific computation to the system.
vssSetDerState
Set the derivative state of a block.
vssGetState
Get the state of a block.
vssGetOparData
Get a given Object parameter that is defined in the Parameters tab.

Intellectual Property Rights Notice | Technical Support | Cookie Consent