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.
Block Manipulation
bdeConvertToSuperBlock
Takes diagram and stores all items within a Super Block.

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
      - bdeAddBlockTextIcon
        Adds a text icon to the block.
      - bdeAddBlockToDiagram
        Adds a block to a diagram. block is of type hwscpHyperBlock.
      - bdeCloneBlock
        Clones block in diagram. block is of type hwscpHyperBlock.
      - bdeConvertToSuperBlock
        Takes diagram and stores all items within a Super Block.
      - bdeCreateBlock
        Creates a block using blockid along with parent. Parent can be of type hwscpDiagram or hwscpBlock but hwscpBlock is not available as a return type from other commands.
      - bdeCreatePort
        Creates a new port for a given block.
      - bdeCreateSuperBlock
        Creates a superblock.
      - bdeDeleteBlock
        Deletes block from diagram. block is of type hwscpHyperBlock.
      - bdeDisableTextIconRotation
        Disables the text icon iconName within block from being rotated.
      - bdeDoFlipBlock
        Flips the block within the ui.
      - bdeEnableTextIconRotation
        Enables the text icon iconName within block to be rotated.
      - bdeExplodeSuperBlock
        Explodes a Super Block.
      - bdeGetBlockAngle
        Gets the rotation angle of the given block.
      - bdeGetBlockBackgroundColor
        Gets the background color of the given block.
      - bdeGetBlockByFullName
        Gets block by the given blockname. Has an option to use diagram as well.
      - bdeGetBlockDefaultName
        Get the deafult name of block. block is of type hwscpHyperBlock.
      - bdeGetBlockDiagram
        Gets the diagram that the block is in. block is of type hwscpHyperBlock.
      - bdeGetBlockFlippedImageAspectRatio
        Gets the aspect ratio of the flipped image in block.
      - bdeGetBlockFlippedImageIconPath
        Gets the path of the flipped image for a given block.
      - bdeGetBlockFrameColor
        Gets the frame color of the block.
      - bdeGetBlockFrameCornerRadius
        Gets the frame corner radius of block. The only blocks that have a corner radius are of frame shape pentagon.
      - bdeGetBlockFrameType
        Gets the frame type of block.
      - bdeGetBlockFullName
        Gets the full name of the given block.
      - bdeGetBlockHeight
        Gets the height of the given block.
      - bdeGetBlockImageAspectRatio
        Gets the image aspect ratio of the image icon in block.
      - bdeGetBlockImageIconPath
        Gets the image path of the icon in block.
      - bdeGetBlockLabelPosition
        Gets the position of the label of block.
      - bdeGetBlockName
        Get the name of block. block is of type hwscpHyperBlock.
      - bdeGetBlockPosition
        Gets the position of the given block.
      - bdeGetBlockReset
        Gets the reset parameters of the template for block.
      - bdeGetBlockShortDescription
        Returns a short description of a given block, if it has one.
      - bdeGetBlockSimulationFunctions
        Gets simulation functions of block from libraryName.
      - bdeGetBlockSimulationLibraries
        Gets simulation libraries of block.
      - bdeGetBlockSimulationLibrariesOfType
        Gets simulation libraries of block of a specific libraryType.
      - bdeGetBlocksInDiagram
        Takes diagram and returns the blocks within the diagram.
      - bdeGetBlockSize
        Gets the block size of the given block.
      - bdeGetBlockStatus
        Returns the value of the property 'status' of a given block.
      - bdeGetBlockTextIconColor
        Gets the color of the text icon iconName in block.
      - bdeGetBlockTextIconFontSize
        Gets the font size of the text icon iconName in block.
      - bdeGetBlockTextIconNames
        Gets the names of the text icons in block.
      - bdeGetBlockTextIconValue
        Gets the value of the text icon name in block.
      - bdeGetBlockTextIconXPosition
        Gets the x position of the text icon iconName in block.
      - bdeGetBlockTextIconYPosition
        Gets the y position of the text icon iconName in block.
      - bdeGetBlockType
        Returns the type of a given block.
      - bdeGetBlockWidth
        Gets the width of the given block.
      - bdeGetBlockXPosition
        Gets the x position of the given block.
      - bdeGetBlockYPosition
        Gets the y position of the given block.
      - bdeGetParentDiagram
        Gets the diagram that the block is in. block is of type hwscpHyperBlock.
      - bdeGetRealTimeScale
        Takes model and returns the scale used for converting the realtime.
      - bdeGetSelectedBlock
        Takes diagram and returns the selected block within the diagram.
      - bdeGetSelectedBlocks
        Takes diagram and returns the selected blocks within the diagram.
      - bdeGetTextIconWithTextName
        Gets the text icon using textIconName from block.
      - bdeIsBlockAtomic
        Checks to see if block is Atomic. block is of type hwscpHyperBlock. Block must be a super block. The Atomic flag is a code generation option that converts a super block into a basic block.
      - bdeIsBlockFlipped
        Returns whether or not the block is flipped.
      - bdeIsBlockFrameVisible
        Returns whether or not the frame of block is visible.
      - bdeIsBlockInlinable
        Returns whether or not the block is inlinable. Inline blocks are blocks that are not included in the library system.
      - bdeIsBlockInlined
        Returns whether or not the block is inlined. Inline blocks are blocks that are not included in the library system.
      - bdeIsBlockLabelVisible
        Gets whether or not the label of block is visible.
      - bdeIsBlockMasked
        Returns the value of the property 'masked' of a given block. Masking hides the interior blocks of a super block and changes the super block to appear and act like a regular block.
      - bdeIsBlockParameterEnabled
        Returns whether or not a parameter of a given block is enabled.
      - bdeIsBlockParameterVisible
        Returns whether or not a parameter of a given block is visible.
      - bdeIsBlockSplit
        Returns the whether or not the block is split. Block is split when it is created using the template 'system/Links/Split'.
      - bdeIsBlockTextIconClipped
        Returns whether or not the block's textIconName is clipped.
      - bdeIsBlockTextIconRotationEnabled
        Returns whether or not the block has text icon rotation enabled.
      - bdeRedrawBlock
        Redraws block within the diagram. block is of type hwscpHyperBlock.
      - bdeReplaceBlock
        Replaces blockToReplace with a copy of replacement in diagram. blockToReplace and replacement are of type hwscpHyperBlock.
      - bdeSaveBlock
        Saves block to pathname. block is of type hwscpHyperBlock. Block must be inline. This means the block is not included in the library system.
      - bdeSaveBlockAsImage
        Saves block to pathname as an image. Must be saved as .png, .jpg, or .jpeg. block is of type hwscpHyperBlock. Block must be inline. This means the block is not included in the library system.
      - bdeSelectBlock
        Selects block within the diagram. block is of type hwscpHyperBlock.
      - bdeSelectBlocks
        Takes diagram and selects the given blocks within the diagram.
      - bdeSetBlockAtomicFlag
        Sets the flag for whether or not the block is atomic. block is of type hwscpHyperBlock. Only works with super blocks.
      - bdeSetBlockBackgroundColor
        Sets the background color of block. Can use either a string for color or four separate rgba values. When using rgba values, values range from 0 to 255.
      - bdeSetBlockDefaultName
        Sets the defualt name for block as name. block is of type hwscpHyperBlock.
      - bdeSetBlockFlippedImageAspectRatio
        Sets the aspect ratio for a flipped image in block.
      - bdeSetBlockFlippedImageIconPath
        Sets the path for a flipped image in block.
      - bdeSetBlockFrameColor
        Sets the block's frame color.
      - bdeSetBlockFrameCornerRadius
        Sets the block's frame corner radius. The only blocks that have a corner radius are of frame shape pentagon.
      - bdeSetBlockFrameType
        Sets the block's frame type. This changes the shape of the block to one of four different options; rectangle, triangle, pentagon, ellipse.
      - bdeSetBlockFrameVisibility
        Sets the flag that determines whether or not the block frame is visible.
      - bdeSetBlockImageAspectRatio
        Sets the aspect ratio of image in block.
      - bdeSetBlockInlinableFlag
        Sets the inlinable flag of a given block. Inline blocks are blocks that are not included in the library system.
      - bdeSetBlockLabelPosition
        Sets the position of the label of block.
      - bdeSetBlockLabelVisibility
        Sets the visibility of the label of block.
      - bdeSetBlockName
        Sets the name for block. block is of type hwscpHyperBlock.
      - bdeSetBlockReset
        Sets reset parameter of the setparams of block.
      - bdeSetBlockShortDescription
        Sets a short description of a given block.
      - bdeSetBlockStatus
        Sets the status of a given block.
      - bdeSetBlockTextIconClipped
        Sets the clipped flag of iconName in block. If clipped the text will only be within the text icon box. If not clipped then the text will be outside of the text icon box, if large enough.
      - bdeSetBlockTextIconColor
        Sets the color of the text icon iconName in block.
      - bdeSetBlockTextIconFontSize
        Sets the font size of text icon textIconName in block.
      - bdeSetBlockTextIconPosition
        Sets the position of text icon textIconName in block.
      - bdeSetBlockTextIconValue
        Sets the value of text icon name to the block.
      - bdeSetBlockType
        Sets the type of a given block.
      - bdeSuperBlockAutoMask
        Sets a superBlock to automatically set it's masked flag to true. Masking hides the interior blocks of a super block and changes the super block to appear and act like a regular block.
    - Block Parameters
    - Dialog
    - Selector Dialog
    - Diagram
    - Editor
    - Links
    - Models
    - 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!

bdeConvertToSuperBlock

Takes diagram and stores all items within a Super Block.

Syntax

superBlock = bdeConvertToSuperBlock(diagram, items)

Inputs

diagram: Diagram being used.; Type: diagram
items: List of items that are being converted to a Super Block.; Type: list

Outputs

superBlock: The superBlock created from the diagram and items.; Type: HyperBlock

Examples

Place items from diagram into a super block:

diagram = bdeGetCurrentDiagram();
        items = bdeGetItemsInDiagram();
        superBlock = bdeConvertToSuperBlock(diagram, items)