Main Content

systemcomposer.view.ElementGroup

Class that represents architecture view element group

    Description

    Use the ElementGroup class to manage element groups in architecture views for a System Composer™ model.

    Creation

    Create a view and get the Root property.

    objView = createView(objModel);
    objElemGroup = objView.Root

    The createView method is the constructor for the systemcomposer.view.View class and its Root property returns the systemcomposer.view.ElementGroup that defines the view.

    Properties

    expand all

    Name of element group, specified as a character vector.

    Example: 'NewElementGroup'

    Data Types: char

    Universal unique identifier for an element group, specified as a character vector.

    Example: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

    Data Types: char

    Elements in a view, specified as a array of systemcomposer.arch.BaseComponent objects.

    Subgroups under the parent element group, specified as an array of systemcomposer.view.ElementGroup objects.

    Object Functions

    addElementAdd component to element group of view
    removeElementRemove component from element group of view
    createSubGroupCreate subgroup in element group of view
    getSubGroupGet subgroup in element group of view
    deleteSubGroupDelete subgroup in element group of view
    destroyRemove model element

    Examples

    collapse all

    This example shows how to use a keyless entry system to programmatically create architecture views using API.

    1. Import the package with the queries.

    import systemcomposer.query.*;

    2. Open the Simulink® project file for the Keyless Entry System.

    scKeylessEntrySystem

    3. Load the example model into System Composer™.

    zcModel = systemcomposer.loadModel('KeylessEntryArchitecture');

    Example 1: Hardware Component Review Status View

    Create a filtered view that selects all of the hardware components in the architecture model and groups them using the ReviewStatus property.

    1. Construct the query to select all of the hardware components.

    hwCompQuery = HasStereotype(IsStereotypeDerivedFrom('AutoProfile.HardwareComponent'))
    hwCompQuery = 
      HasStereotype with properties:
    
        AllowedParentConstraints: {1x3 cell}
                   SubConstraint: [1x1 systemcomposer.query.IsStereotypeDerivedFrom]
                  SkipValidation: 0
    
    

    2. Use the query to create a view.

    zcModel.createView('Hardware Component Review Status',...
     'Select',hwCompQuery,... % Query to use for the selection
     'GroupBy',{'AutoProfile.BaseComponent.ReviewStatus'},... % Stereotype property to qualify by
     'IncludeReferenceModels',true,... % Include components in referenced models
     'Color','purple');

    3. Open the Architecture Views Gallery.

    zcModel.openViews

    Example 2: FOB Locator System Supplier View

    This example shows how to create a freeform view that manually pulls the components from the FOB Locator System and then groups them using existing and new view components for the suppliers. In this example, you will use element groups, groupings of components in a view, to programmatically populate a view.

    1. Create a view architecture.

    fobSupplierView = zcModel.createView('FOB Locator System Supplier Breakdown',...
        'Color','lightblue');

    2. Add a subgroup called 'Supplier D'. Add the FOB Locator Module to the view element subgroup.

    supplierD = fobSupplierView.Root.createSubGroup('Supplier D');
    supplierD.addElement('KeylessEntryArchitecture/FOB Locator System/FOB Locator Module');

    3. Create a new subgroup for 'Supplier A'.

    supplierA = fobSupplierView.Root.createSubGroup('Supplier A');

    4. Add each of the FOB Receivers to view element subgroup.

    FOBLocatorSystem = zcModel.lookup('Path','KeylessEntryArchitecture/FOB Locator System');
    
    % Find all the components which contain the name "Receiver"
    receiverCompPaths = zcModel.find(...
        contains(systemcomposer.query.Property('Name'),'Receiver'),...
        FOBLocatorSystem.Architecture);
    
    supplierA.addElement(receiverCompPaths)

    More About

    expand all

    Introduced in R2021a