MATLAB: How to programmatically access the description text of the documentation pane of a signal line in Simulink 7.9 (R2012a)

apidescriptiondocumentationgetget_paramlinesetsignalsimulinktext;

I have added a description in the property dialog documentation pane of a Simulink signal (right click on the signal -> Signal Properties -> Documentation: Description).

I am looking for a way to programmatically access the content of the description field.

Best Answer

You can use the 'Description' property of the 'porthandles' as shown in the following example:

p1 = get_param('signalDoc/Const','porthandles')
get(p1.Outport,'Description')
% set a new description
set(p1.Outport,'Description','My new Description.')

Related Solutions

MATLAB: How to modify GET_PARAM to return ‘OutputSignals’ property of ‘Bus Selector’ as a cell array

The functionality to obtain the 'Output Signals' property of 'Bus Selector' block as a cell array is not available in Simulink 6.6 (R2007a).

As a workaround, you can use 'porthandles' property of the block and then use 'Name' property of output ports as in the following example:

ph = get_param('busdemo/Bus Selector', 'porthandles');
a = get_param(ph.Outport,'Name');

MATLAB: Does the signal description fail to show up when I use GET_PARAM on an input port or a line object in Simulink

The following set of commands will yield the signal description once you have selected the signal in your Simulink model:

a = get_param(gcb,'PortHandles');
line = get_param(a.Inport,'Line');
Srcport = get_param(line, 'Srcporthandle');
b = get_param(Srcport, 'Description')

Best Answer

Related Solutions

MATLAB: How to modify GET_PARAM to return ‘OutputSignals’ property of ‘Bus Selector’ as a cell array

MATLAB: Does the signal description fail to show up when I use GET_PARAM on an input port or a line object in Simulink

Related Question