fmiModelDescription

Arguments

fmu

tlist, a model that can be received by importFMU.

description

tlist, a structure containing all information for fmiModelDescription.

• description.fmiVersion : string, a version of FMI.
• description.fmiType : string, a type of FMU (Model Exchange or Co-Simulation).
• description.modelName : string, a name of the model as used in the modelling environment that generated the xml-file.
• description.modelIdentifier : string that is used as prefix in the C-function names of the model.
• description.guid : string, a "Globally Unique IDentifier" is a string that is used to check if the xml-file is compatible with the C-functions of the model.
• description.description : string, short description of the model.
• description.author : string, gives the name and organization of the model author.
• description.version : string, a version of the model (e.g. "1.1").
• description.generationTool : string, a name of the tool that generated the xml-file.
• description.generationDateAndTime : string, a date and time when the xml-file was generated.
• description.variableNamingConvention : string, a type of naming convention for variables and types definitions of model from XML description file.
• description.numberOfContinuousStates : double, a number of (fixed) continuous states.
• description.numberOfEventIndicators : double, a number of (fixed) event indicators.
• description.UnitDefinitions : double, a number of "Unit Definitions" of model.
• description.TypeDefinitions : double, a number of "Type Definitions" of model.
• description.VendorAnnotations : double, a number of "Vendor Annotations" of model.
• description.ModelVariables : double, a number of "Model Variables" of model.
• description.DefaultExperiment : tlist that consists of the optional default "start time", "stop time" and "relative tolerance" for the first simulation of the model.
• description.DirectDependency : tlist that consists of the information about the dependency of an output from its inputs of model.
• description.Implementation : tlist that consists of the information about the implementation of model (only for Co-Simulation).

Description

fmiModelDescription is the function that returns the description of the model according to the root-level schema of XML file.

Examples

//Decompressing the model "SCADE_CruiseControl__CruiseControl_FMU". Creation a variable "fmu" of type tlist Scilab. 
fmu = importFMU(fullfile(SCI, "modules", "fmu", "tests", "unit_tests", "SCADE_CruiseControl__CruiseControl_FMU.fmu"));
//The convention of FMU model variables and type definitions.
description = fmiModelDescription(fmu)

See Also

• fmiModelVariables — Full information about model variables.