SystemModel

Objects used for design and analysis of dynamical systems.

Entity["SystemModel",name]or

represents an entity of type "SystemModel".

[prop]

gives the value of a specified property.

[{prop1,…}]

gives the value of a list of properties.

EntityClass["SystemModel",{propispeci,…}]

represents a class of entities with values of propi defined by speci.

Properties

  • "AlgebraicVariables"nondifferentiated variables
    "Balanced"if the model is balanced in equations and variables
    "Children"child models in a package hierarchy
    "ClassCategories"model categories
    "Components"model components
    "Connections"model connections
    "Connectors"model connectors components
    "Description"top-level description of model
    "Diagram"diagram view of model
    "DiscreteVariables"variables changing only at events
    "DocumentationURL"link to model documentation
    "Domain"association describing a modeling domain
    "DomainChart"chart describing a modeling domain
    "ExtendsModels"models this model extends
    "GroupedInitialValues"initial values grouped by states, inputs and outputs
    "InheritedComponents"components defined in "ExtendsModels"
    "InheritedConnections"connections defined in "ExtendsModels"
    "InheritedConnectors"connectors defined in "ExtendsModels"
    "InheritedPlotNames"
  • names of plots inherited from "ExtendsModels"
    • "InheritedPlots"plot specifications defined in "ExtendsModels"
    "InitialEquations"initial value equations
    "InitialSeedings"guess values for initialization
    "InitialValues"initial value rules {v1val1,…}
    "InputVariables"variables specified as inputs
    "Label"the identifier for the model
    "LocalComponents"components defined locally in model
    "LocalConnections"connections defined locally in model
    "LocalConnectors"connectors defined locally in model
    "LocalPlotNames"names of plots defined locally in model
    "LocalPlots"plot specifications defined locally in model
    "ModelicaIcon"icon view of model
    "ModelicaString"Modelica model code as a string
    "ModelName"fully qualified path of model
    "ModelsContaining"models that use this model as a component
    "ModelsExtending"models that extend this model
    "OutputVariables"
  • variables specified as outputs
    • "ParameterNames"parameters
    "ParameterValues"parameter rules {p1val1,…}
    "Parent"the parent model in a package hierarchy
    "PlotNames"names of plots in a model
    "Plots"model plot specifications
    "Siblings"sibling models in a package hierarchy
    "SimulationModel"
  • if the model is a simulation model
    • "SimulationSettings"model simulation settings
    "SourceFile"
  • file where the model is saved
    • "Specialization"specialization "model", "package", "function", …
    "StateVariables"differentiated variables
    "SystemEquations"differential and algebraic equations
    "SystemVariables"state and algebraic variables
    "Thumbnail"model thumbnail
    "TopInitialValues"initial values for top variables
    "TopParameterNames"parameters excluding component parameters
    "TopParameterValues"top parameter values
    "TopSystemVariables"system variables excluding component variables
    "Version"version information of model

Details

  • "SystemModel" entities include classes stored in System Modeler libraries as well as user-generated models.
  • Information such as diagram, components and system equations are available for all models.
  • Some properties are available for the "SystemModel" entity type as a whole and can be given using the form EntityValue["SystemModel",property]. Such properties include:
  • "Properties"the list of available properties
    "PropertyCanonicalNames"the standard names of available properties
    "SampleEntities"a sample list of available entities (typically of length 10)
    "SampleEntityClasses"a sample list of available entity classes (typically of length 10)
    "EntityCount"number of entities available
    "Entities"the list of available entities
    "EntityCanonicalNames"the standard names of available entities
    "EntityClasses"the list of available entity classes
    "EntityClassCanonicalNames"the standard names of available entity classes
    "PropertyClasses"the list of available property classes
    "PropertyClassCanonicalNames"the standard names of available property classes
    "PropertyCount"number of properties available
  • The following annotations can be used in the third argument of EntityValue["SystemModel",property,annotation]:
  • "Source"source information for the property
    "Date"the date associated with the entity-property value (if any)
    "EntityAssociation"an association of entities and entity-property values
    "PropertyAssociation"an association of properties and entity-property values
    "EntityPropertyAssociation"an association in which the specified entities are keys, and values are a nested association of properties and entity-property values
    "PropertyEntityAssociation"an association in which the specified properties are keys, and values are a nested association of entities and entity-property values
    "Dataset"a dataset in which the specified entities are keys, and values are an association of property names and entity-property values
  • The following annotations can be used in the second argument of EntityValue[property,annotation]:
  • "Qualifiers"the list of possible qualifiers for the property
    "QualifierValues"the list of possible values that can be given to each qualifier
    "DefaultQualifierValues"the list of default values for the property's qualifiers
    "Description"a brief textual description of the property
    "Definition"a detailed textual definition of the property
    "PhysicalQuantity"the physical quantity associated with the entity-property value
    "Unit"the unit associated with the entity-property value
  • A qualifier value of Automatic indicates that an applicable format of values can be used; e.g. for the "Date" qualifier, this includes a proper date or date span.

Examples

Basic Examples  (4)

Find a property value for an entity:

Find a list of property values for an entity:

A property value for an entity may return other "SystemModel" entities:

Obtain the list of entities that belong to a class: