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.
Models
bdeSetModelDescription
Takes model and description and sets the description parameter.

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
      - bdeCloseCurrentModel
        Closes the current model in use.
      - bdeCloseModel
        Closes model, which is a hwscpDiagram.
      - bdeCreateNewModel
        Creates a new model. Option to use filename., which is a scm file.
      - bdeExistsModel
        Determines if a filepath is open or if a filename exists.
      - bdeGetCurrentDiagram
        Gets the current diagram that is being used. Is of type hwscpDiagram.
      - bdeGetCurrentModel
        Gets the current model in use.
      - bdeGetCurrentModelFilePath
        Gets the current model's file path.
      - bdeGetCurrentModelName
        Gets the name of the model that is currently in use, which is of type hwString.
      - bdeGetModelCreationDate
        Takes model and returns it's creation date.
      - bdeGetModelCreator
        Takes model and returns it's creator.
      - bdeGetModelDescription
        Takes model and returns a description about it.
      - bdeGetModelDiagram
        Returns the diagram of the given model, which is a hwscpDiagram.
      - bdeGetModelFilePath
        Takes model and returns the model's file path.
      - bdeGetModelFinalization
        Takes model and returns finalization values.
      - bdeGetModelInitialization
        Takes model and returns initialization values.
      - bdeGetModelLastModifiedDate
        Takes model and returns the last time the model was modified.
      - bdeGetModelName
        Gets name of given model.
      - bdeGetModelRevision
        Takes model and returns whether the model has been revised.
      - bdeGetModelRoot
        Returns the root of the model, which is a hwscpDiagram.
      - bdeGetModelTempDir
        Gets the pathname of the temporary directory of the given model.
      - bdeGetModelVersion
        Takes model and returns current version.
      - bdeLaunchSetupGui
        Launches a dialog box that contains the simulation parameters for a diagram.
      - bdeLoadModel
        Reads filename, which is a scm file. Loads model from filename.
      - bdeSaveCurrentModelToTempDir
        Saves current model to temporary directory.
      - bdeSaveModel
        Saves model to filename.
      - bdeSetModelCreationDate
        Takes model and date and sets the creation date parameter.
      - bdeSetModelCreator
        Takes model and name and sets the creator parameter.
      - bdeSetModelDescription
        Takes model and description and sets the description parameter.
      - bdeSetModelFinalization
        Takes model and value and sets the finalization parameters.
      - bdeSetModelInitialization
        Takes model and value and sets the initialization parameters.
      - bdeSetModelLastModifiedDate
        Takes model and date and sets the last modified date parameter.
      - bdeSetModelRevision
        Takes model and value and sets the revision parameter.
      - bdeSetModelVersion
        Takes model and value and sets the version parameter.
    - Ports
    - Simulation Settings
  - 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!

bdeSetModelDescription

Takes model and description and sets the description parameter.

Syntax

bdeSetModelDescription(model, description)

Inputs

model: Model who's description parameter is being set.; Type: diagram
description: Description to set the description parameter to.; Type: string

Examples

Set a model's description:

model = bdeGetCurrentModel();
	  bdeSetModelLastModifiedDate(model, description)