Main Content

setDescription

Set description for value type or interface

Since R2021b

    Description

    setDescription(valueType,description) sets the description for the designated value type.

    example

    setDescription(interface,description) sets the description for the designated interface.

    Examples

    collapse all

    Create a model archModel.

    modelName = "archModel";
    arch = systemcomposer.createModel(modelName);
    systemcomposer.openModel(modelName);

    Add a value type airSpeed to the dictionary of the model.

    airSpeedType = arch.InterfaceDictionary.addValueType("airSpeed");

    Set the description for the value type as Maintain altitude.

    airSpeedType.setDescription("Maintain altitude")

    Input Arguments

    collapse all

    Value type, data element, or function argument, specified as a systemcomposer.ValueType, systemcomposer.interface.DataElement, or systemcomposer.interface.FunctionArgument object.

    Description, specified as a character vector or string.

    Data Types: char | string

    More About

    collapse all

    Version History

    Introduced in R2021b

    See Also

    Functions

    Objects

    Blocks

    Tools