systemcomposer.analysis.Instance

Class that represents architecture model element in analysis instance

Description

The Instance class represents an instance of an architecture.

Creation

Create an instance of an architecture

instance = instantiate(modelHandle,architecture,properties,name)

Properties

expand all

`Name` — Name of instance
character vector

Name of instance, returned as a character vector.

Data Types: char

`Specification` — Specification for creating instance
architecture | component | port | connector

Specification for creating instance, returned as a systemcomposer.arch.Architecture, systemcomposer.arch.Component, systemcomposer.arch.ArchitecturePort, systemcomposer.arch.ComponentPort, or systemcomposer.arch.Connector object. The specification depends on the kind of instance.

Architecture Instance Properties

`Components` — Child components of instance
array of components

Child components of instance, returned as an array of systemcomposer.analysis.ComponentInstance objects.

`Ports` — Ports of architecture instance
array of ports

Ports of architecture instance, returned as an array of systemcomposer.analysis.PortInstance objects.

`Connectors` — Connectors in architecture instance
array of connectors

Connectors in architecture instance, returned as an array of systemcomposer.analysis.ConnectorInstance objects, connecting child components.

`Specification` — References element in model
architecture object

References element in model, returned as a systemcomposer.analysis.ArchitectureInstance object.

Component Instance Properties

`Components` — Child components of instance
array of components

Child components of instance, returned as an array of systemcomposer.analysis.ComponentInstance objects within the architecture.

`Ports` — Ports of component instance
array of ports

Ports of component instance, returned as an array of systemcomposer.analysis.PortInstance objects.

`Connectors` — Connectors in component instance
array of connectors

Connectors in component instance, connecting child components, returned as an array of systemcomposer.analysis.ConnectorInstance objects.

`Parent` — Parent of the component
architecture object

Parent of the component, returned as a systemcomposer.analysis.ArchitectureInstance object.

`Specification` — References element in model
architecture object

References element in model, returned as a systemcomposer.analysis.ArchitectureInstance object.

Port Instance Properties

`Parent` — Component that contains the port
component instance object

Component that contains the port, returned as a systemcomposer.analysis.ComponentInstance object.

Connector Instance Properties

`Parent` — Component that contains connector
component instance object

Component that contains connector, returned as a systemcomposer.analysis.ComponentInstance object.

`SourcePort` — Source port instance
port instance object

Source port instance, returned as a systemcomposer.analysis.PortInstance object.

`DestinationPort` — Destination port instance
port instance object

Destination port instance, returned as a systemcomposer.analysis.PortInstance object.

`Specification` — References element in model
architecture object

References element in model, returned as a systemcomposer.analysis.ArchitectureInstance object.

Object Functions

`getValue`	Get value of property from element instance
`setValue`	Set value of property for element instance
`isArchitecture`	Find if instance is architecture instance
`isComponent`	Find if instance is component instance
`isConnector`	Find if instance is connector instance
`isPort`	Find if instance is port instance

Documentation

systemcomposer.analysis.Instance

Description

Creation

Properties

`Name` — Name of instance
character vector

`Specification` — Specification for creating instance
architecture | component | port | connector

Architecture Instance Properties

`Components` — Child components of instance
array of components

`Ports` — Ports of architecture instance
array of ports

`Connectors` — Connectors in architecture instance
array of connectors

`Specification` — References element in model
architecture object

Component Instance Properties

`Components` — Child components of instance
array of components

`Ports` — Ports of component instance
array of ports

`Connectors` — Connectors in component instance
array of connectors

`Parent` — Parent of the component
architecture object

`Specification` — References element in model
architecture object

Port Instance Properties

`Parent` — Component that contains the port
component instance object

Connector Instance Properties

`Parent` — Component that contains connector
component instance object

`SourcePort` — Source port instance
port instance object

`DestinationPort` — Destination port instance
port instance object

`Specification` — References element in model
architecture object

Object Functions

See Also

Topics

System Composer Documentation

Support

Documentation

systemcomposer.analysis.Instance

Description

Creation

Properties

Name — Name of instance character vector

Specification — Specification for creating instance architecture | component | port | connector

Architecture Instance Properties

Components — Child components of instance array of components

Ports — Ports of architecture instance array of ports

Connectors — Connectors in architecture instance array of connectors

Specification — References element in model architecture object

Component Instance Properties

Components — Child components of instance array of components

Ports — Ports of component instance array of ports

Connectors — Connectors in component instance array of connectors

Parent — Parent of the component architecture object

Specification — References element in model architecture object

Port Instance Properties

Parent — Component that contains the port component instance object

Connector Instance Properties

Parent — Component that contains connector component instance object

SourcePort — Source port instance port instance object

DestinationPort — Destination port instance port instance object

Specification — References element in model architecture object

Object Functions

See Also

Topics

System Composer Documentation

Support

`Name` — Name of instance
character vector

`Specification` — Specification for creating instance
architecture | component | port | connector

`Components` — Child components of instance
array of components

`Ports` — Ports of architecture instance
array of ports

`Connectors` — Connectors in architecture instance
array of connectors

`Specification` — References element in model
architecture object

`Components` — Child components of instance
array of components

`Ports` — Ports of component instance
array of ports

`Connectors` — Connectors in component instance
array of connectors

`Parent` — Parent of the component
architecture object

`Specification` — References element in model
architecture object

`Parent` — Component that contains the port
component instance object

`Parent` — Component that contains connector
component instance object

`SourcePort` — Source port instance
port instance object

`DestinationPort` — Destination port instance
port instance object

`Specification` — References element in model
architecture object