Main Content

removeElement

Remove element from service interface

Since R2023b

collapse all in page

    Syntax

    removeElement(serviceInterfaceObj,elementName)

    Description

    removeElement(serviceInterfaceObj,elementName) removes the function element with the name elementName from the service interface ServiceInterfaceObj.

    example

    Examples

    collapse all

    To configure function elements of a service interface, use the addElement, getElement, and removeElement functions.

    In this example, the dictionary MyInterfaces.sldd contains one service interface.

    archDataObj = Simulink.dictionary.archdata.open("MyInterfaces.sldd")
    archDataObj = 

  ArchitecturalData with properties:

    DictionaryFileName: 'MyInterfaces.sldd'
            Interfaces: [1×1 Simulink.dictionary.archdata.ServiceInterface]
             DataTypes: [0×0 Simulink.dictionary.archdata.DataType]
             Constants: [0×0 Simulink.dictionary.archdata.Constant]

    Get the service interface object using the getInterface function. The service interface object contains two function element objects.

    serviceInterfaceObj = getInterface(archDataObj,"ServiceInterface1")
    serviceInterfaceObj = 

  ServiceInterface with properties:

           Name: 'ServiceInterface1'
    Description: ''
       Elements: [1×2 Simulink.dictionary.archdata.FunctionElement]
          Owner: [1×1 Simulink.dictionary.ArchitecturalData]

    To create a function element object and add it to the service interface, use the addElement function.

    funcElemObj3 = addElement(serviceInterfaceObj,"functionElement3")
    funcElemObj3 = 

  FunctionElement with properties:

    FunctionPrototype: 'y = functionElement3(u)'
         Asynchronous: 0
    FunctionArguments: [1×2 Simulink.dictionary.archdata.FunctionArgument]
                 Name: 'functionElement3'
                Owner: [1×1 Simulink.dictionary.archdata.ServiceInterface]

    To access an existing function element, use the getElement function.

    funcElemObj2 = getElement(serviceInterfaceObj,"functionElement2")
    funcElemObj2 = 

  FunctionElement with properties:

    FunctionPrototype: 'y = functionElement2(u)'
         Asynchronous: 0
    FunctionArguments: [1×2 Simulink.dictionary.archdata.FunctionArgument]
                 Name: 'functionElement2'
                Owner: [1×1 Simulink.dictionary.archdata.ServiceInterface]

    To remove a function element from a service interface, use the removeElement function. 

    removeElement(serviceInterfaceObj,"functionElement1")

    The service interface object now contains only two function elements, functionElement2 and functionElement3.

    serviceInterfaceObj.Elements(1)
    ans = 

  FunctionElement with properties:

    FunctionPrototype: 'y = functionElement2(u)'
         Asynchronous: 0
    FunctionArguments: [1×2 Simulink.dictionary.archdata.FunctionArgument]
                 Name: 'functionElement2'
                Owner: [1×1 Simulink.dictionary.archdata.ServiceInterface]
    serviceInterfaceObj.Elements(2)
    ans = 

  FunctionElement with properties:

    FunctionPrototype: 'y = functionElement3(u)'
         Asynchronous: 0
    FunctionArguments: [1×2 Simulink.dictionary.archdata.FunctionArgument]
                 Name: 'functionElement3'
                Owner: [1×1 Simulink.dictionary.archdata.ServiceInterface]

    Input Arguments

    collapse all

    Service interface containing the function element, specified as a Simulink.dictionary.archdata.ServiceInterface object.

    Function element name, specified as a character vector or string scalar.

    Data Types: char | string

    Version History

    Introduced in R2023b

    See Also

    |

    Topics