removeField

Remove properties from block data set metadata

Since R2025a

collapse all in page

    Syntax

    Metadata = removeField(Metadata,fieldNames)

    Description

    Metadata = removeField(Metadata,fieldNames) removes the field, fieldNames, from the block data set Metadata object, Metadata.

    example

    Examples

    collapse all

    This example shows how to create a BlockDataSet object from a block and remove a metadata field.

    Create a model that contains a Simscape block. This example uses a Capacitor block from the Foundation Library.

    modelName = "myModel";
close_system(modelName,0) 
libraryBlockName = "fl_lib/Electrical/Electrical Elements/Capacitor";
open_system(new_system(modelName));
blockName = add_block(libraryBlockName,modelName + "/" + "Example block");

    Create a block data set from the Capacitor block and display the metadata.

    myDataSet = partrepo.simscape.dataSetFromBlock(blockName);
disp(myDataSet.Metadata)
    Metadata (Incomplete) with properties:

            Manufacturer: ""
              PartNumber: ""
               BlockType: "SimscapeBlock"
    ParameterizationDate: "19-Nov-2024"
         SimulinkRelease: "25.1"
          ReferenceBlock: "fl_lib/Electrical/Electrical Elements/Capacitor"
          LibraryVersion: "25001000.1"
        ModelingEntityId: "foundation.electrical.elements.capacitor"
      ModelingEntityType: "SimscapeComponent"
        CustomIdentifier: ""
            PartSchemaId: "defaultSimscapeSchema"

    Add RatedPower and PartSeries metadata properties, then display the updated metadata.

    myDataSet.Metadata.RatedPower = simscape.Value(3,"W")
myDataSet.Metadata.PartSeries ="c1"
disp(myDataSet.Metadata)
    myDataSet = 

  BlockDataSet with properties:

            ID: "||" (format)
      Metadata: [1×1 Metadata] (13 entries, Incomplete)
    Parameters: [1×1 Parameters] (3 entries)

  Metadata (Incomplete) with properties:

            Manufacturer: ""
              PartNumber: ""
               BlockType: "SimscapeBlock"
    ParameterizationDate: "22-Jan-2025"
         SimulinkRelease: "25.1"
          ReferenceBlock: "fl_lib/Electrical/Electrical Elements/Capacitor"
          LibraryVersion: "25001000.1"
        ModelingEntityId: "foundation.electrical.elements.capacitor"
      ModelingEntityType: "SimscapeComponent"
        CustomIdentifier: ""
            PartSchemaId: "defaultSimscapeSchema"

              RatedPower: 3 (W)
              PartSeries: "c1"

    Remove the PartSeries property and display the updated metadata.

    myDataSet.Metadata = myDataSet.Metadata.removeField("PartSeries")
disp(myDataSet.Metadata)
    Metadata (Incomplete) with properties:

            Manufacturer: ""
              PartNumber: ""
               BlockType: "SimscapeBlock"
    ParameterizationDate: "22-Jan-2025"
         SimulinkRelease: "25.1"
          ReferenceBlock: "fl_lib/Electrical/Electrical Elements/Capacitor"
          LibraryVersion: "25001000.1"
        ModelingEntityId: "foundation.electrical.elements.capacitor"
      ModelingEntityType: "SimscapeComponent"
        CustomIdentifier: ""
            PartSchemaId: "defaultSimscapeSchema"

              RatedPower: 3 (W)

    Input Arguments

    collapse all

    Metadata of a block data set, specified as a partrepo.simscape.Metadata object.

    Names of the field to remove, specified as a character vector or string scalar that contains the property name.

    Data Types: char | string

    Output Arguments

    collapse all

    Updated Simscape block data set metadata, returned as a partrepo.simscape.Metadata object.

    Version History

    Introduced in R2025a

    See Also

    | |