Main Content

setDescription

Set description for signal interface element

    Description

    example

    setDescription(interfaceElem,description) sets the description for the designated signal interface element.

    Examples

    collapse all

    Create a model named 'archModel', add an interface, create an interface element with a name 'x', and set the description for the interface element 'Test Description'.

    modelName = 'archModel';
    arch = systemcomposer.createModel(modelName); % Create model
    
    interface = arch.InterfaceDictionary.addInterface('interface'); % Add interface
    elem = interface.addElement('x'); % Create interface element
    
    setDescription(elem,'Test Description'); % Set description for interface element

    Input Arguments

    collapse all

    Interface element, specified as a systemcomposer.interface.SignalElement object.

    Description of interface element, specified as a character vector.

    Data Types: char

    Introduced in R2019a