<< fmu_ulink fmu_wrapper loadFMU >>

fmu_wrapper >> fmu_wrapper > importFMU

importFMU

Decompressing the model and parsing of XML description file.

Calling Sequence

fmu = importFMU(path)
[fmu, obj] = importFMU(path)

Arguments

path

string, a path for a model.

fmu

tlist, model.

  • fmu.modelFileName : string, a file name.
  • fmu.xmlFile : string, a path for XML description.
  • fmu.libraryFile : string, a path for binary file.
  • fmu.userPath : string, a relative path for model.
  • fmu.simulationLibrary : pointer, a dynamic linked library.
  • fmu.descriptionFMU : tlist, main attributes of XML description.
  • fmu.fmiType : string, a type of FMU (me - Model Exchange, cs - Co-Simulation).
  • fmu.modelVariables : tlist, main attributes of XML description.
  • fmu.setValues : struct, configuration of parameters, start values of variables for fmiSimulate.
  • fmu.getValues : struct, getting the results of simulation for fmiSimulate.
obj

data structure of a model containing any information for a model file.

Description

importFMU is the function which decompress a model at TMP Folder with the same name as the name of FMU file. Also, this function returns full information for all model variables(fmu.modelVariables ). This function returns tlist for a model containing: modelFileName, simulationLibrary, xmlDescription. It's possible to use this function to obtain more information about a model file(second output argument obj).

Examples

//Decompressing the model "SCADE_CruiseControl__CruiseControl_FMU". Creation a variable fmu of type tlist Scilab. 
fmu = importFMU(pwd()+fullfile("\tests\unit_tests\SCADE_CruiseControl__CruiseControl_FMU.fmu"))
//Decompressing FMU model "SCADE_CruiseControl__CruiseControl_FMU". Creation a variable fmu of type tlist Scilab and obj a data structure. 
[fmu, obj] = importFMU(pwd()+fullfile("\tests\unit_tests\SCADE_CruiseControl__CruiseControl_FMU.fmu"))

See Also


Report an issue
<< fmu_ulink fmu_wrapper loadFMU >>