Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Function Guide for Twin Activate
Provides information about developing and simulating models through the Twin Activate Application Program Interface.
Block Diagram Editor APIs
Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
Simulation Settings
bdeSetSimulationProfilingEnabled
Sets a flag for profiling of the simulation. When true this function generates a CSV file in the model's temporary directory when the simulation is run. The file contains the simulation's flag information for all the simulation blocks. Can use bdeGetModelTempDir to find the temporary directory where the information is stored.

Welcome
What's New
Discover new features and enhancements.
Get Started
New to Twin Activate? Learn the basics here.
Tutorials
Start using Twin Activate with our interactive tutorials.
User Guide
Learn about the features and functionality available in Twin 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 Twin Activate library.
- Function Guide for Twin Activate
  Provides information about developing and simulating models through the Twin Activate Application Program Interface.
  - Block Diagram Editor APIs
    Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
    - Annotations
    - Block Manipulation
    - Block Parameters
    - Dialog
    - Selector Dialog
    - Diagram
    - Editor
    - Links
    - Models
    - Ports
    - Simulation Settings
      - bdeGetBlockScopesHandles
        Get the handle of all the scopes in a certain block.
      - bdeGetAbsoluteErrorTolerance
        Takes model and returns the absolute error tolerance.
      - bdeGetAlgebraicSolver
        Takes model and returns algebraic solver being used.
      - bdeGetFinalTime
        Takes model and returns the value stored in the final time.
      - bdeGetInitialStepSize
        Takes model and returns the initial step size.
      - bdeGetInitialTime
        Takes model and returns the value stored in the initial time.
      - bdeGetJacobianMethod
        Takes model and returns the Jacobian method being used.
      - bdeGetMaxNumberofSteps
        Takes model and returns the maximum number of steps.
      - bdeGetMaxStepSize
        Takes model and returns the maximum step size.
      - bdeGetMinStepSize
        Takes model and returns the minimum step size.
      - bdeGetNumberOfConsecutiveZeroCrossing
        Takes model and returns the number of times it consecutively crosses zero.
      - bdeGetRelativeErrorTolerance
        Takes model and returns the relative error tolerance.
      - bdeGetSolver
        Takes model and returns the solver being used.
      - bdeGetTimeTolerance
        Takes model and returns the time tolerance.
      - bdeGetTimeToleranceZeroCrossing
        Takes model and returns the time tolerance in relation to zero crossing.
      - bdeGetZeroCrossingThreshold
        Takes model and returns the zero crossing threshold.
      - bdeIsSimulationWithAnimation
        Returns a value representing if a simulation has animations enabled.
      - bdeSetAbsoluteErrorTolerance
        Takes model and errorTolerance and sets the absolute error tolerance value.
      - bdeSetAlgebraicSolver
        Takes model and solver and sets the algebraic solver of the model.
      - bdeSetDefaultModelSimulationParams
        Sets the simulation parameters of a diagram to the default values.
      - bdeSetFinalTime
        Takes model and time and sets the final time value.
      - bdeSetInitialStepSize
        Takes model and initialSize and sets initial step size.
      - bdeSetInitialTime
        Takes model and time and sets the initial time value.
      - bdeSetJacobianMethod
        Takes model and method and sets the Jacobian method to be used.
      - bdeSetMaxNumberOfSteps
        Takes model and numSteps and sets the maximum number of steps.
      - bdeSetMaxStepSize
        Takes model and maxSize and sets maximum step size.
      - bdeSetMinStepSize
        Takes model and minSize and sets the minimum step size property.
      - bdeSetNumberOfConsecutiveZeroCrossing
        Takes model and num and sets the number of consecutive zero crossing. Used to help see if functions get stuck on zero.
      - bdeSetRealTimeScale
        Takes model and scale and sets the real time scale value.
      - bdeSetRelativeErrorTolerance
        Takes model and errorTolerance and sets the relative error tolerance value.
      - bdeSetSimulationAnimationEnabled
        Sets the simulation to have animation enabled.
      - bdeSetSimulationProfilingEnabled
        Sets a flag for profiling of the simulation. When true this function generates a CSV file in the model's temporary directory when the simulation is run. The file contains the simulation's flag information for all the simulation blocks. Can use bdeGetModelTempDir to find the temporary directory where the information is stored.
      - bdeSetSimulationResultsEnabled
        Sets the simulation to have results enabled.
      - bdeSetSimulationResultsFile
        Sets the filename and path for the results of a simulation.
      - bdeSetSimulationResultsToBeShown
        Sets a simulations results to be shown in the ui.
      - bdeSetSimulationResultsInModelDirectoryEnabled
        Sets the simulation results to be stored in the model's temporary directory.
      - bdeSetSolver
        Takes model and solver and sets solver to be used.
      - bdeSetTimeTolerance
        Takes model and timeTolerance and sets the time tolerance property.
      - bdeSetTimeToleranceZeroCrossing
        Takes model and timeTolerance and sets the time tolerance of zero crossing.
      - bdeSetZeroCrossingThreshold
        Takes model and threshold and sets the zero crossing threshold property. When zero crossing is detected on a function e.g. F, F changes the sign and becomes almost zero. When the absolute value becomes greater than the threshold, the zero-crossing search resumes. This is used to handle functions that get stuck on zero.
  - 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.
- Glossary
  Key terms associated with the software.
Frequently Asked Questions
You've got questions? We've got answers!

bdeSetSimulationProfilingEnabled

Sets a flag for profiling of the simulation. When true this function generates a CSV file in the model's temporary directory when the simulation is run. The file contains the simulation's flag information for all the simulation blocks. Can use bdeGetModelTempDir to find the temporary directory where the information is stored.

Syntax

bdeSetSimulationProfilingEnabled(enable)

Inputs

enable: Boolean representing whether or not to enable the flag that creates a CSV of all the simulation's flags.; Type: Boolean

Examples

Set a simulation's flag to create a profile CSV in the model's temporary directory:


          bdeSetSimulationProfilingEnabled(true);