addElement

Add signal interface element

Syntax

element = addElement(interface,name)

element = addElement(interface,name,Name,Value)

Description

element = addElement(interface,name) adds an element to a signal interface with default properties.

element = addElement(interface,name,Name,Value) sets the properties of the element as specified in Name,Value.

Examples

Add an Interface and an Element

Add an interface newsignal to the interface dictionary of the model, and add an element newelement with type double.

arch = systemcomposer.createModel('newmodel',0);
interface = addInterface(arch.InterfaceDictionary,'newsignal');
element = addElement(interface,'newelement','Type','double')

element = 
  SignalElement with properties:

      Interface: [1×1 systemcomposer.interface.SignalInterface]
           Name: 'newelement'
           Type: 'double'
     Dimensions: '1'
          Units: ''
     Complexity: 'real'
        Minimum: '[]'
        Maximum: '[]'
    Description: ''
           UUID: '2b47eaa6-191a-439a-ba2b-2bcc3209b912'
    ExternalUID: ''

Input Arguments

interface — New interface object

signal interface

New interface object, specified as a systemcomposer.interface.SignalInterface object.

name — Name of new element

character vector

Name of new element with a valid variable name, specified as a character vector.

Data Types: char

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Type', 'double'

'Type' — Data type of element

valid data type character vector

Data type of element, specified as the comma-separated pair consisting of 'Type' and a valid data type character vector.

Data Types: char

'Dimensions' — Dimensions of element

positive integer array

Dimensions of element, specified as the comma-separated pair consisting of 'Dimensions' and a positive integer array. Each element of the array is the size of the element in the corresponding direction. A scalar integer indicates a scalar or vector element and a row vector with two integers indicates a matrix element.

Data Types: double

'Complexity' — Complexity of element

'real' | 'complex'

Complexity of element, specified as the comma-separated pair 'Complexity' and 'real' if the element is purely real, or 'complex' if an imaginary part is allowed.

Data Types: char

Output Arguments

element — New interface element object

signal element

New interface element object, returned as a systemcomposer.interface.SignalElement object.