::RegisterTypedAnalysis
This command registers a new customized analysis entity type in MotionView.
Syntax
::model::RegisterTypedAnalysis argPanel argFolder argPanelFile argPanelFunc argIconFile argShowBrowserFolder argForPair argDefinitionFile argDefinitionVarname argShowAsContainer argType
Application
MotionView Tcl
Description
This command registers a new customized analysis entity type in MotionView.
Inputs
- argPanel
- The variable name that is to be checked for validity.
- argFolder
- The text displayed in the folder in the browser that is to contain the instances of these entities.
- argPanelFile
- The full path of the file that contains the panel configuration. This file will be sourced to display the panel.
- argPanelFunc
- The name of the function in the “argPanelFile” that is to be called to initiate the display of the panel.
- argIconFile
- The file name of the icon that is associated with this entity type.
- argShowBrowserFolder
- This registered entity type being displayed in a folder in the browser is determined by the value of this argument. If the value is true, the entity instances are displayed in a folder in the browser, otherwise they are not.
- argForPair
- If this registered entity type is for a pair, then this argument is true, otherwise it is false.
- argDefinitionFile
- The full path of the MDL definition fie that contains the definition to be used for this customized analysis entity type.
- argDefinitionVarname
- The definition varname (in the “argDefinitionFile”) that is to be used to define the customized analysis entity.
- argShowAsContainer
- If the contents of this customized analysis entity type are to be displayed in the browser, this argument needs to be true, otherwise it is set to false.
- argType
- The type that is to be assigned to instances of this customized analysis entity.
Example
::model::RegisterTypedAnalysis analysis "Analysis" "NewAnalysis.tcl" "mainfunction" "Newanalysisentity.png" true false Newanaldef.mdl ana_def_new true "NEWANALYSIS"Error
On successful execution of the command, a new analysis entity will be registered.