Main Content

getFunctionArgument

Get function argument on function element

    Description

    example

    arg = getFunctionArgument(functionElem,argName) gets the function argument argName specified by a function prototype from a function defined by the function element functionElem.

    Examples

    collapse all

    Create a new model.

    model = systemcomposer.createModel("archModel","SoftwareArchitecture",true);

    Create a service interface.

    interface = addServiceInterface(model.InterfaceDictionary,"newServiceInterface");

    Create a function element.

    element = addElement(interface,"newFunctionElement");

    Set a function prototype to add function arguments.

    setFunctionPrototype(element,"y=f0(u)")

    Get a function argument.

    argument = getFunctionArgument(element,"y")
    argument = 
    
      FunctionArgument with properties:
    
          Interface: [1×1 systemcomposer.interface.ServiceInterface]
            Element: [1×1 systemcomposer.interface.FunctionElement]
               Name: 'y'
               Type: [1×1 systemcomposer.ValueType]
         Dimensions: '1'
        Description: ''
               UUID: '018b4e55-fa8f-4250-ac2b-df72bf620feb'
        ExternalUID: ''

    Input Arguments

    collapse all

    Function element, specified as a systemcomposer.interface.FunctionElement object.

    Argument name, specified as a character vector or string.

    Example: "y"

    Data Types: char | string

    Output Arguments

    collapse all

    Function argument, returned as a systemcomposer.interface.FunctionArgument object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    software architecture

    A software architecture is a specialization of an architecture for software-based systems, including the description of software compositions, component functions, and their scheduling.

    Use software architectures in System Composer™ to author software architecture models composed of software components, ports, and interfaces. Design your software architecture model, define the execution order of your component functions, simulate your design in the architecture level, and generate code.

    software component

    A software component is a specialization of a component for software entities, including its functions (entry points) and interfaces.

    Implement a Simulink® export-function, rate-based, or JMAAB model as a software component, simulate the software architecture model, and generate code.

    software composition

    A software composition is a diagram of software components and connectors that represents a composite software entity, such as a module or application.

    Encapsulate functionality by aggregating or nesting multiple software components or compositions.

    Modeling Software Architecture of Throttle Position Control System
    function

    A function is an entry point that can be defined in a software component.

    You can apply stereotypes to functions in software architectures, edit sample times, and specify the function period using the Functions Editor.

    Author and Extend Functions for Software Architectures
    service interface

    A service interface defines the functional interface between client and server components. Each service interface consists of one or more function elements.

    Once you have defined a service interface in the Interface Editor, you can assign it to client and server ports using the Property Inspector. You can also use the Property Inspector to assign stereotypes to service interfaces.

    function element

    A function element describes the attributes of a function in a client-server interface.

    Edit the function prototype on a function element to change the number and names of inputs and outputs of the function. Edit function element properties as you would edit other interface element properties. Function argument types can include built-in types as well as bus objects. You can specify function elements to support:

    • Synchronous execution — When the client calls the server, the function runs immediately and returns the output arguments to the client.

    • Asynchronous execution — When the client makes a request to call the server, the function is executed asynchronously based on the priority order defined in the Functions Editor and Schedule Editor and returns the output arguments to the client.

    systemcomposer.interface.FunctionElement
    function argument

    A function argument describes the attributes of an input or output argument in a function element.

    You can set the properties of a function argument in the Interface Editor just as you would any value type: Type, Dimensions, Units, Complexity, Minimum, Maximum, and Description.

    systemcomposer.interface.FunctionArgument
    class diagram

    A class diagram is a graphical representation of a static structural model that displays unique architecture types of the software components optionally with software methods and properties.

    Class diagrams capture one instance of each referenced model and show relationships between them. Any component diagram view can be optionally represented as a class diagram for a software architecture model.

    Class Diagram View of Software Architectures

    TermDefinitionApplicationMore Information
    interface data dictionary

    An interface data dictionary is a consolidated list of all the interfaces and value types in an architecture and where they are used.

    Local interfaces on a System Composer model can be saved in an interface data dictionary using the Interface Editor. You can reuse interface dictionaries between models that need to use a given set of interfaces, elements, and value types. Linked data dictionaries are stored in separate SLDD files.

    data interface

    A data interface defines the kind of information that flows through a port. The same interface can be assigned to multiple ports. A data interface can be composite, meaning that it can include data elements that describe the properties of an interface signal.

    Data interfaces represent the information that is shared through a connector and enters or exits a component through a port. Use the Interface Editor to create and manage data interfaces and data elements and store them in an interface data dictionary for reuse between models.

    data element

    A data element describes a portion of an interface, such as a communication message, a calculated or measured parameter, or other decomposition of that interface.

    Data interfaces are decomposed into data elements:

    • Pins or wires in a connector or harness.

    • Messages transmitted across a bus.

    • Data structures shared between components.

    value type

    A value type can be used as a port interface to define the atomic piece of data that flows through that port and has a top-level type, dimension, unit, complexity, minimum, maximum, and description.

    You can also assign the type of data elements in data interfaces to value types. Add value types to data dictionaries using the Interface Editor so that you can reuse the value types as interfaces or data elements.

    Create Value Types as Interfaces
    owned interface

    An owned interface is an interface that is local to a specific port and not shared in a data dictionary or the model dictionary.

    Create an owned interface to represent a value type or data interface that is local to a port.

    Define Owned Interfaces Local to Ports
    adapter

    An adapter helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay or rate transition. You can also use an adapter for bus creation. Use the Adapter block to implement an adapter.

    With an adapter, you can perform functions on the Interface Adapter dialog:

    • Create and edit mappings between input and output interfaces.

    • Apply an interface conversion UnitDelay to break an algebraic loop.

    • Apply an interface conversion RateTransition to reconcile different sample time rates for reference models.

    • When output interfaces are undefined, you can use input interfaces in bus creation mode to author owned output interfaces.

    Version History

    Introduced in R2022a