addElement
Description
adds an element to an interface with default properties.element
= addElement(interface
,name
)
To remove an element from an interface, use the removeElement
function.
sets the properties of the element using name-value arguments.element
= addElement(interface
,name
,Name,Value
)
Examples
Add Data Interface and Data Element
Create a new model newModel
. Add a data interface
newInterface
to the interface dictionary of the model. Then, add a
data element newElement
with data type
double
.
arch = systemcomposer.createModel("newModel",true); interface = addInterface(arch.InterfaceDictionary,"newInterface"); element = addElement(interface,"newElement",DataType="double")
element = DataElement with properties: Interface: [1×1 systemcomposer.interface.DataInterface] Name: 'newElement' Type: [1×1 systemcomposer.ValueType] UUID: '2d267175-33c2-43a9-be41-a1be2774a3cf' ExternalUID: ''
Add Physical Interface and Physical Element
Create a new model named 'newModel'
. Add a
physical interface 'newInterface'
to the interface dictionary of the
model. Then, add a physical element 'newElement'
with type
'electrical.electrical'
. Change the physical domain type to
'electrical.six_phase'
.
arch = systemcomposer.createModel('newModel',true); interface = addPhysicalInterface(arch.InterfaceDictionary,'newInterface'); element = addElement(interface,'newElement','Type','electrical.electrical'); element.Type = 'electrical.six_phase'; element
element = PhysicalElement with properties: Name: 'newElement' Type: [1×1 systemcomposer.interface.PhysicalDomain] Interface: [1×1 systemcomposer.interface.PhysicalInterface] UUID: '32e4c51e-e567-42f1-b44a-2d2fcdbb5c25' ExternalUID: ''
Input Arguments
interface
— Interface
data interface object | physical interface object | service interface object
Interface, specified as a systemcomposer.interface.DataInterface
, systemcomposer.interface.PhysicalInterface
, or systemcomposer.interface.ServiceInterface
object.
name
— Element name
character vector | string
Element name, specified as a character vector or string. An element name must be a valid MATLAB® variable name.
Data Types: char
| string
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: addElement(interface,"newElement",DataType="double",Dimensions="2",Units="m/s",Complexity="complex",Minimum="0",Maximum="100",Description="Maintain
altitude")
DataType
— Data type
character vector | string
Data type, specified as a character vector or string for a valid MATLAB data type. The default value is double
.
Example: addElement(interface,"newElement",DataType="double")
Data Types: char
| string
Dimensions
— Dimensions
character vector | string
Dimensions, specified as a character vector or string. The default value is
1
.
Example: addElement(interface,"newElement",Dimensions="2")
Data Types: char
| string
Units
— Units
character vector | string
Units, specified as a character vector or string.
Example: addElement(interface,"newElement",Units="m/s")
Data Types: char
| string
Complexity
— Complexity
character vector | string
Complexity, specified as a character vector or string. The default value is
real
. Other possible values are complex
and
auto
.
Example: addElement(interface,"newElement",Complexity="complex")
Data Types: char
| string
Minimum
— Minimum
character vector | string
Minimum, specified as a character vector or string.
Example: addElement(interface,"newElement",Minimum="0")
Data Types: char
| string
Maximum
— Maximum
character vector | string
Maximum, specified as a character vector or string.
Example: addElement(interface,"newElement",Maximum="100")
Data Types: char
| string
Description
— Description
character vector | string
Description, specified as a character vector or string.
Example: addElement(interface,"newElement",Description="Maintain
altitude")
Data Types: char
| string
Type
— Physical domain
character vector | string
Physical domain of physical element, specified as a character vector or string of a partial physical domain name. For a list of valid physical domain names, see Domain-Specific Line Styles (Simscape).
Example: addElement(interface,"newElement",Type="electrical.six_phase")
Data Types: char
| string
Output Arguments
element
— Element
data element object | physical element object | function element object
Element, returned as a systemcomposer.interface.DataElement
, systemcomposer.interface.PhysicalElement
, or systemcomposer.interface.FunctionElement
object.
More About
Definitions
Term | Definition | Application | More 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:
| |
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 box:
|
Version History
Introduced in R2019a
MATLAB-Befehl
Sie haben auf einen Link geklickt, der diesem MATLAB-Befehl entspricht:
Führen Sie den Befehl durch Eingabe in das MATLAB-Befehlsfenster aus. Webbrowser unterstützen keine MATLAB-Befehle.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)