Method ssm/setBlockDescriptions


  SETBLOCKDESCRIPTIONS Sets descriptions of the specified SSM blocks.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SETBLOCKDESCRIPTIONS Sets descriptions of the specified SSM blocks.
 
  CALL:        obj = obj.setBlockDescriptions('block_type', blockIndices, {'block_description1', ...});
               obj = obj.setBlockDescriptions('block_type', {'old_name1', ...}, {'new_description1', ...});
               obj = obj.setBlockDescriptions('block_type', BlockName, newBlockDescription);
 
   blockname may be a double, a string or a cell-array of strings of size 1
   newBlockDescription may be a string or a cell-array of strings
 
  Parameters Description
 
  VERSION: $Id: setBlockDescriptions.m,v 1.13 2012/01/27 12:59:57 ingo Exp $
  
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ssm
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
FIELD 'inputs'
  • 'inputs'
  • 'outputs'
  • 'states'
The field being changed
BLOCKS [] none Identifiers (strings or indices) of the blocks you want to modify
DESCRIPTIONS [] none The new description(s) you want to set to the block(s). Use a cell-array, one entry for each block.
back to top back to top

Some information of the method ssm/setBlockDescriptions are listed below:
Class name ssm
Method name setBlockDescriptions
Category Helper
CVS Version $Id: setBlockDescriptions.m,v 1.13 2012/01/27 12:59:57 ingo Exp $
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team