Main Content

createView

Create architecture view

    Description

    view = createView(model,viewName) creates a new architecture view view for the System Composer™ model model with the specified name viewName.

    example

    view = createView(___,Name,Value) creates a new view with additional options.

    Examples

    collapse all

    Open the keyless entry system example and create a view. Specify the color as light blue and the query as all components, and group by the review status.

    scKeylessEntrySystem
    import systemcomposer.query.*;
    model = systemcomposer.loadModel('KeylessEntryArchitecture');
    view = model.createView('All Components Grouped by Review Status',...
        'Color','lightblue','Select',AnyComponent(),...
        'GroupBy','AutoProfile.BaseComponent.ReviewStatus');

    Open the Architecture Views Gallery to see the new view named 'All Components Grouped by Review Status'.

    model.openViews

    Input Arguments

    collapse all

    Model, specified as a systemcomposer.arch.Model object.

    Name of new view, specified as a character vector.

    Example: 'All Components Grouped by Review Status'

    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: view = model.createView('All Components Grouped by Review Status','Color','lightblue','Select',AnyComponent(),'GroupBy','AutoProfile.BaseComponent.ReviewStatus')

    Selection query to use to populate the view, specified as a comma-separating pair consisting of 'Select' and a systemcomposer.query.Constraint object. A constraint can contain a sub-constraint that can be joined with another constraint using AND or OR. A constraint can be negated using NOT.

    Example: HasStereotype(IsStereotypeDerivedFrom('AutoProfile.HardwareComponent'))

    Query Objects and Conditions for Constraints

    Query ObjectCondition
    PropertyA non-evaluated value for the given property or stereotype property.
    PropertyValueAn evaluated property value from a System Composer object or a stereotype property.
    HasPortA component has a port that satisfies the given sub-constraint.
    HasInterfaceA port has an interface that satisfies the given sub-constraint.
    HasInterfaceElementAn interface has an interface element that satisfies the given sub-constraint.
    HasStereotypeAn architecture element has a stereotype that satisfies the given sub-constraint.
    IsInRangeA property value is within the given range.
    AnyComponentAn element is a component and not a port or connector.
    IsStereotypeDerivedFrom A stereotype is derived from the given stereotype.

    Grouping criteria, specified as a comma-separating pair consisting of 'GroupBy' and a cell array of properties in the form '<profile>.<stereotype>.<property>'. The order of the cell array dictates the order of the grouping.

    Example: {'AutoProfile.MechanicalComponent.mass','AutoProfile.MechanicalComponent.cost'}

    Whether to search for reference architectures, specified as the comma-separated pair consisting of 'IncludeReferenceModels' and a logical 1 (true) to search for referenced architectures or 0 (false) to not include referenced architectures.

    Example: 'IncludeReferenceModels',false

    Data Types: logical

    Color of view, specified as the comma-separated pair consisting of 'Color' and a character array that contains the name of the color or an RGB hexadecimal value.

    Example: 'Color','blue'

    Example: 'Color,'#FF00FF'

    Data Types: char

    Output Arguments

    collapse all

    Architecture view, returned as a systemcomposer.view.View object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    architectureA System Composer architecture represents a system of components and how they interface with each other structurally and behaviorally. You can represent specific architectures using alternate views.

    Different types of architectures describe different aspects of systems:

    • Functional architecture describes the flow of data in a system.

    • Logical architecture describes the intended operation of a system.

    • Physical architecture describes the platform or hardware in a system.

    Compose Architecture Visually
    modelA System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.

    Perform operations on a model:

    • Extract the root level architecture contained in the model.

    • Apply profiles.

    • Link interface data dictionaries.

    • Generate instances from model architecture.

    System Composer models are stored as .slx files.

    Create an Architecture Model
    componentA component is a nontrivial, nearly-independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architecture element, such as a function, a system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction.Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts.Components
    portA port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems.

    There are different types of ports:

    • Component ports are interaction points on the component to other components.

    • Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.

    Ports
    connectorConnectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures.A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact.Connections

    TermDefinitionApplicationMore Information
    viewA view shows a customizable subset of elements in a model. Views can be filtered based on stereotypes or names of components, ports, and interfaces, along with the name, type, or units of an interface element. Construct views by pulling in elements manually. Views create a simplified way to work with complex architectures by focusing on certain parts of the architecture design.

    You can use different types of views to represent the system:

    • Operational views demonstrate how a system will be used and should be well integrated with requirements analysis.

    • Functional views focus on what the system must do to operate.

    • Physical views show how the system is constructed and configured.

    A viewpoint represents a stakeholder perspective that specifies the contents of the view.

    element groupAn element group is a grouping of components in a view.Use element groups to programmatically populate a view.Create Architectural Views Programmatically
    queryA query is a specification that describes certain constraints or criteria to be satisfied by model elements.Use queries to search elements with constraint criteria and to filter views.Find Elements in a Model Using Queries

    Introduced in R2021a