Merge branch 'main' of https://github.com/0815Creeper/FMIImport.jl in…

…to 0815Creeper-main
ThummeTo · Nov 6, 2023 · b78f08d · b78f08d
2 parents a8f6d4d + c20ad49
commit b78f08d
Show file tree

Hide file tree

Showing 16 changed files with 905 additions and 337 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Project.toml b/docs/Project.toml
diff --git a/docs/make.jl b/docs/make.jl
diff --git a/docs/src/contents.md b/docs/src/contents.md
diff --git a/docs/src/fmi2_library.md b/docs/src/fmi2_library.md
diff --git a/docs/src/fmi3_library.md b/docs/src/fmi3_library.md
diff --git a/docs/src/overview.md b/docs/src/overview.md
diff --git a/docs/src/related.md b/docs/src/related.md
diff --git a/src/FMI2/convert.jl b/src/FMI2/convert.jl
@@ -96,7 +96,8 @@ function fmi2ModelVariablesForValueReference(md::fmi2ModelDescription, vr::fmi2V
 end
 
 """
-ToDo.
+    fmi2DataTypeForValueReference(md::fmi2ModelDescription, vr::fmi2ValueReference)
+Returns the fmi2DataType (`fmi2Real`, `fmi2Integer`, `fmi2Boolean`, `fmi2String`) for a given Valuereference `vr` of a given FMU-ModelDescription `md`
 """
 function fmi2DataTypeForValueReference(md::fmi2ModelDescription, vr::fmi2ValueReference)
     mv = fmi2ModelVariablesForValueReference(md, vr)[1]

diff --git a/src/FMI2/ext.jl b/src/FMI2/ext.jl
@@ -99,7 +99,7 @@ end
 function dlsym_opt(libHandle, symbol)
     addr = dlsym(libHandle, symbol; throw_error=false)
     if addr == nothing
-        logWarn(fmu, "This FMU does not support function '$symbol'.")
+        logWarning(fmu, "This FMU does not support function '$symbol'.")
         addr = Ptr{Cvoid}(C_NULL)
     end
     addr
@@ -257,6 +257,10 @@ function fmi2Load(pathToFMU::String; unpackPath::Union{String, Nothing}=nothing,
     return fmu
 end
 
+"""
+    loadBinary(fmu::FMU2)
+load pointers to `fmu`\`s c functions from shared library handle (provided by `fmu.libHandle`)
+"""
 function loadBinary(fmu::FMU2)
     lastDirectory = pwd()
     cd(dirname(fmu.binaryPath))
@@ -518,7 +522,7 @@ function fmi2Instantiate!(fmu::FMU2;
         end
 
         if !isnothing(component)
-            logWarn(fmu, "fmi2Instantiate!(...): This component was already registered. This may be because you created the FMU by yourself with FMIExport.jl.")
+            logWarning(fmu, "fmi2Instantiate!(...): This component was already registered. This may be because you created the FMU by yourself with FMIExport.jl.")
         else
             component = FMU2Component(compAddr, fmu)
 

diff --git a/src/FMI2/md.jl b/src/FMI2/md.jl
@@ -1471,7 +1471,7 @@ Returns a dictionary `Dict(fmi2ValueReference, Array{String})` of derivative val
 
 # Returns
 - `dict::Dict{fmi2ValueReference, Array{String}}`: Returns a dictionary that constructs a hash table with keys of type fmi2ValueReference and values of type Array{String}. So returns a dict with (vrs, names of derivatives)
-See also [fmi2GetValueReferencesAndNames`](@ref)
+See also [`fmi2GetValueReferencesAndNames`](@ref)
 """
 function fmi2GetDerivateValueReferencesAndNames(md::fmi2ModelDescription)
     fmi2GetValueReferencesAndNames(md::fmi2ModelDescription; vrs=md.derivativeValueReferences)
@@ -1487,7 +1487,7 @@ Returns a dictionary `Dict(fmi2ValueReference, Array{String})` of derivative val
 
 # Returns
 - `dict::Dict{fmi2ValueReference, Array{String}}`: Returns a dictionary that constructs a hash table with keys of type fmi2ValueReference and values of type Array{String}. So returns a dict with (vrs, names of derivatives)
-See also [fmi2GetValueReferencesAndNames`](@ref)
+See also [`fmi2GetValueReferencesAndNames`](@ref)
 """
 function fmi2GetDerivateValueReferencesAndNames(fmu::FMU2)
     fmi2GetDerivateValueReferencesAndNames(fmu.modelDescription)