From 055e79097e2ffbb5a960ddc375b06b262c6fe916 Mon Sep 17 00:00:00 2001 From: Simon Exner Date: Thu, 19 Oct 2023 10:17:17 +0200 Subject: [PATCH] doc updates for comp_wraps --- src/FMI2/comp_wraps.jl | 171 ++++++++++++++-------- src/FMI3/comp_wraps.jl | 321 ++++++++++++++++++++++++++--------------- 2 files changed, 315 insertions(+), 177 deletions(-) diff --git a/src/FMI2/comp_wraps.jl b/src/FMI2/comp_wraps.jl index 7d66e6e0..ba408116 100644 --- a/src/FMI2/comp_wraps.jl +++ b/src/FMI2/comp_wraps.jl @@ -11,7 +11,8 @@ """ fmi2Simulate(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2Simulate() in FMI/FMI2_sim.jl +Wrapper for `fmi2Simulate(fmu::FMU2, c::Union{FMU2Component, Nothing}, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets passed as `nothing`) """ function fmi2Simulate(fmu::FMU2, args...; kwargs...) return fmi2Simulate(fmu, nothing, args...; kwargs...) @@ -20,7 +21,8 @@ end """ fmi2SimulateCS(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SimulateCS() in FMI/FMI2_sim.jl +Wrapper for `fmi2SimulateCS(fmu::FMU2, c::Union{FMU2Component, Nothing}, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets passed as `nothing`) """ function fmi2SimulateCS(fmu::FMU2, args...; kwargs...) return fmi2SimulateCS(fmu, nothing, args...; kwargs...) @@ -29,7 +31,8 @@ end """ fmi2SimulateME(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SimulateME() in FMI/FMI2_sim.jl +Wrapper for `fmi2SimulateME(fmu::FMU2, c::Union{FMU2Component, Nothing}, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets passed as `nothing`) """ function fmi2SimulateME(fmu::FMU2, args...; kwargs...) return fmi2SimulateME(fmu, nothing, args...; kwargs...) @@ -38,7 +41,8 @@ end """ fmi2FreeInstance!(fmu::FMU2) -Wrapper for fmi2FreeInstance!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2FreeInstance!(c::FMU2Component; popComponent::Bool = true)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2FreeInstance!(fmu::FMU2) fmi2FreeInstance!(getCurrentComponent(fmu)) # this command also removes the component from the array @@ -47,7 +51,8 @@ end """ fmi2SetDebugLogging(fmu::FMU2) -Wrapper for fmi2SetDebugLogging() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetDebugLogging(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetDebugLogging(fmu::FMU2) fmi2SetDebugLogging(getCurrentComponent(fmu)) @@ -56,7 +61,8 @@ end """ fmi2SetupExperiment(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetupExperiment() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetupExperiment(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetupExperiment(fmu::FMU2, args...; kwargs...) fmi2SetupExperiment(getCurrentComponent(fmu), args...; kwargs...) @@ -65,7 +71,8 @@ end """ fmi2EnterInitializationMode(fmu::FMU2) -Wrapper for fmi2EnterInitializationMode() in FMIImport/FMI2_c.jl +Wrapper for `fmi2EnterInitializationMode(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2EnterInitializationMode(fmu::FMU2) fmi2EnterInitializationMode(getCurrentComponent(fmu)) @@ -74,7 +81,8 @@ end """ fmi2ExitInitializationMode(fmu::FMU2) -Wrapper for fmi2ExitInitializationMode() in FMIImport/FMI2_c.jl +Wrapper for `fmi2ExitInitializationMode(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2ExitInitializationMode(fmu::FMU2) fmi2ExitInitializationMode(getCurrentComponent(fmu)) @@ -83,7 +91,8 @@ end """ fmi2Terminate(fmu::FMU2) -Wrapper for fmi2Terminate() in FMIImport/FMI2_c.jl +Wrapper for `fmi2Terminate(c::FMU2Component; soft::Bool=false)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2Terminate(fmu::FMU2) fmi2Terminate(getCurrentComponent(fmu)) @@ -92,7 +101,8 @@ end """ fmi2Reset(fmu::FMU2) -Wrapper for fmi2Reset() in FMIImport/FMI2_c.jl +Wrapper for `fmi2Reset(c::FMU2Component; soft::Bool=false)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2Reset(fmu::FMU2) fmi2Reset(getCurrentComponent(fmu)) @@ -101,7 +111,8 @@ end """ fmi2GetReal(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetReal() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetReal(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetReal(fmu::FMU2, args...; kwargs...) fmi2GetReal(getCurrentComponent(fmu), args...; kwargs...) @@ -110,7 +121,8 @@ end """ fmi2GetReal!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetReal!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetReal!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetReal!(fmu::FMU2, args...; kwargs...) fmi2GetReal!(getCurrentComponent(fmu), args...; kwargs...) @@ -119,7 +131,8 @@ end """ fmiGet(fmu::FMU2, args...; kwargs...) -Wrapper for fmiGet() in FMIImport/FMI2_ext.jl +Wrapper for `fmiGet(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2Get(fmu::FMU2, args...; kwargs...) fmi2Get(getCurrentComponent(fmu), args...; kwargs...) @@ -128,7 +141,8 @@ end """ fmiGet!(fmu::FMU2, args...; kwargs...) -Wrapper for fmiGet!() in FMIImport/FMI2_ext.jl +Wrapper for `fmiGet!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2Get!(fmu::FMU2, args...; kwargs...) fmi2Get!(getCurrentComponent(fmu), args...; kwargs...) @@ -137,7 +151,8 @@ end """ fmiSet(fmu::FMU2, args...; kwargs...) -Wrapper for fmiSet() in FMIImport/FMI2_ext.jl +Wrapper for `fmiSet(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2Set(fmu::FMU2, args...; kwargs...) fmi2Set(getCurrentComponent(fmu), args...; kwargs...) @@ -146,7 +161,8 @@ end """ fmi2GetRealOutputDerivatives(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetRealOutputDerivatives() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetRealOutputDerivatives(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetRealOutputDerivatives(fmu::FMU2, args...; kwargs...) fmi2GetRealOutputDerivatives(getCurrentComponent(fmu), args...; kwargs...) @@ -155,7 +171,8 @@ end """ fmi2SetReal(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetReal() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetReal(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetReal(fmu::FMU2, args...; kwargs...) fmi2SetReal(getCurrentComponent(fmu), args...; kwargs...) @@ -164,7 +181,8 @@ end """ fmi2SetRealInputDerivatives(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetRealInputDerivatives() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetRealInputDerivatives(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetRealInputDerivatives(fmu::FMU2, args...; kwargs...) fmi2SetRealInputDerivatives(getCurrentComponent(fmu), args...; kwargs...) @@ -173,7 +191,8 @@ end """ fmi2GetInteger(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetInteger() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetInteger(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetInteger(fmu::FMU2, args...; kwargs...) fmi2GetInteger(getCurrentComponent(fmu), args...; kwargs...) @@ -182,7 +201,8 @@ end """ fmi2GetInteger!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetInteger!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetInteger!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetInteger!(fmu::FMU2, args...; kwargs...) @@ -192,7 +212,8 @@ end """ fmi2SetInteger(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetInteger() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetInteger(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetInteger(fmu::FMU2, args...; kwargs...) @@ -202,7 +223,8 @@ end """ fmi2GetBoolean(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetBoolean() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetBoolean(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetBoolean(fmu::FMU2, args...; kwargs...) @@ -212,7 +234,8 @@ end """ fmi2GetBoolean!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetBoolean!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetBoolean!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetBoolean!(fmu::FMU2, args...; kwargs...) @@ -222,7 +245,8 @@ end """ fmi2SetBoolean(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetBoolean() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetBoolean(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetBoolean(fmu::FMU2, args...; kwargs...) @@ -232,7 +256,8 @@ end """ fmi2GetString(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetString() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetString(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetString(fmu::FMU2, args...; kwargs...) @@ -242,7 +267,8 @@ end """ fmi2GetString!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetString!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetString!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetString!(fmu::FMU2, args...; kwargs...) @@ -252,7 +278,8 @@ end """ fmi2SetString(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetString() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SetString(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetString(fmu::FMU2, args...; kwargs...) @@ -262,7 +289,8 @@ end """ fmi2GetFMUstate(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetFMUstate() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetFMUstate(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetFMUstate(fmu::FMU2, args...; kwargs...) @@ -272,7 +300,8 @@ end """ fmi2SetFMUstate(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetFMUstate() in FMIImport/FMI2_c.jl +Wrapper for `fmi2SetFMUstate(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetFMUstate(fmu::FMU2, args...; kwargs...) @@ -282,7 +311,8 @@ end """ fmi2FreeFMUstate!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2FreeFMUstate!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2FreeFMUstate!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2FreeFMUstate!(fmu::FMU2, args...; kwargs...) @@ -292,7 +322,8 @@ end """ fmi2SerializedFMUstateSize(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SerializedFMUstateSize() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SerializedFMUstateSize(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SerializedFMUstateSize(fmu::FMU2, args...; kwargs...) @@ -302,7 +333,8 @@ end """ fmi2SerializeFMUstate(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SerializeFMUstate() in FMIImport/FMI2_int.jl +Wrapper for `fmi2SerializeFMUstate(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SerializeFMUstate(fmu::FMU2, args...; kwargs...) @@ -312,7 +344,8 @@ end """ fmi2DeSerializeFMUstate(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2DeSerializeFMUstate() in FMIImport/FMI2_int.jl +Wrapper for `fmi2DeSerializeFMUstate(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2DeSerializeFMUstate(fmu::FMU2, args...; kwargs...) @@ -322,7 +355,8 @@ end """ fmi2GetDirectionalDerivative!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetDirectionalDerivative!() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetDirectionalDerivative!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetDirectionalDerivative!(fmu::FMU2, args...; kwargs...) @@ -332,7 +366,8 @@ end """ fmi2GetDirectionalDerivative(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetDirectionalDerivative() in FMIImport/FMI2_int.jl +Wrapper for `fmi2GetDirectionalDerivative(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetDirectionalDerivative(fmu::FMU2, args...; kwargs...) @@ -342,7 +377,8 @@ end """ fmi2SampleDirectionalDerivative!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SampleDirectionalDerivative!() in FMIImport/FMI2_ext.jl +Wrapper for `fmi2SampleDirectionalDerivative!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SampleDirectionalDerivative!(fmu::FMU2, args...; kwargs...) @@ -352,7 +388,8 @@ end """ fmi2SampleDirectionalDerivative(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SampleDirectionalDerivative() in FMIImport/FMI2_ext.jl +Wrapper for `fmi2SampleDirectionalDerivative(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SampleDirectionalDerivative(fmu::FMU2, args...; kwargs...) @@ -362,7 +399,8 @@ end """ fmi2GetJacobian!(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetJacobian!() in FMIImport/FMI2_ext.jl +Wrapper for `fmi2GetJacobian!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetJacobian!(fmu::FMU2, args...; kwargs...) @@ -372,7 +410,8 @@ end """ fmi2GetJacobian(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetJacobian() in FMIImport/FMI2_ext.jl +Wrapper for `fmi2GetJacobian(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetJacobian(fmu::FMU2, args...; kwargs...) @@ -382,7 +421,8 @@ end """ fmi2DoStep(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2DoStep() in FMIImport/FMI2_c.jl +Wrapper for `fmi2DoStep(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2DoStep(fmu::FMU2, args...; kwargs...) @@ -392,7 +432,8 @@ end """ fmi2CancelStep(fmu::FMU2) -Wrapper for fmi2CancelStep() in FMIImport/FMI2_c.jl +Wrapper for `fmi2CancelStep(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2CancelStep(fmu::FMU2) @@ -402,7 +443,8 @@ end """ fmi2GetStatus(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetStatus!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetStatus!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetStatus(fmu::FMU2, args...; kwargs...) @@ -412,7 +454,8 @@ end """ fmi2GetRealStatus(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetRealStatus!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetRealStatus!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetRealStatus(fmu::FMU2, args...; kwargs...) @@ -422,7 +465,8 @@ end """ fmi2GetIntegerStatus(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetIntegerStatus!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetIntegerStatus!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetIntegerStatus(fmu::FMU2, args...; kwargs...) @@ -432,7 +476,8 @@ end """ fmi2GetBooleanStatus(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetBooleanStatus!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetBooleanStatus!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetBooleanStatus(fmu::FMU2, args...; kwargs...) @@ -442,7 +487,8 @@ end """ fmi2GetStringStatus(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetStringStatus!() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetStringStatus!(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetStringStatus(fmu::FMU2, args...; kwargs...) @@ -452,7 +498,8 @@ end """ fmi2SetTime(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetTime() in FMIImport/FMI2_c.jl +Wrapper for `fmi2SetTime(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetTime(fmu::FMU2, args...; kwargs...) @@ -462,7 +509,8 @@ end """ fmi2SetContinuousStates(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2SetContinuousStates() in FMIImport/FMI2_c.jl +Wrapper for `fmi2SetContinuousStates(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2SetContinuousStates(fmu::FMU2, args...; kwargs...) @@ -472,7 +520,8 @@ end """ fmi2EnterEventMode(fmu::FMU2) -Wrapper for fmi2EnterEventMode() in FMIImport/FMI2_c.jl +Wrapper for `fmi2EnterEventMode(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2EnterEventMode(fmu::FMU2) @@ -482,7 +531,8 @@ end """ fmi2NewDiscreteStates(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2NewDiscreteStates() in FMIImport/FMI2_c.jl +Wrapper for `fmi2NewDiscreteStates(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2NewDiscreteStates(fmu::FMU2, args...; kwargs...) @@ -492,7 +542,8 @@ end """ fmi2EnterContinuousTimeMode(fmu::FMU2) -Wrapper for fmi2EnterContinuousTimeMode() in FMIImport/FMI2_c.jl +Wrapper for `fmi2EnterContinuousTimeMode(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2EnterContinuousTimeMode(fmu::FMU2) @@ -502,7 +553,8 @@ end """ fmi2CompletedIntegratorStep(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2CompletedIntegratorStep() in FMIImport/FMI2_c.jl +Wrapper for `fmi2CompletedIntegratorStep(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2CompletedIntegratorStep(fmu::FMU2, args...; kwargs...) @@ -512,7 +564,8 @@ end """ fmi2GetDerivatives(fmu::FMU2) -Wrapper for fmi2GetDerivatives() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetDerivatives(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetDerivatives(fmu::FMU2) @@ -522,7 +575,8 @@ end """ fmi2GetEventIndicators(fmu::FMU2) -Wrapper for fmi2GetEventIndicators() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetEventIndicators()` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetEventIndicators(fmu::FMU2) @@ -532,7 +586,8 @@ end """ fmi2GetContinuousStates(fmu::FMU2)fmi2ins -Wrapper for fmi2GetContinuousStates() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetContinuousStates(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetContinuousStates(fmu::FMU2) @@ -542,7 +597,8 @@ end """ fmi2GetNominalsOfContinuousStates(fmu::FMU2) -Wrapper for fmi2GetNominalsOfContinuousStates() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetNominalsOfContinuousStates(c::FMU2Component)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetNominalsOfContinuousStates(fmu::FMU2) @@ -553,7 +609,8 @@ end """ fmi2GetStartValue(fmu::FMU2, args...; kwargs...) -Wrapper for fmi2GetStartValue() in FMIImport/FMI2_c.jl +Wrapper for `fmi2GetStartValue(c::FMU2Component, args...; kwargs...)` without a provided FMU2Component. +(Component `c` gets selected from `fmu`) """ function fmi2GetStartValue(fmu::FMU2, args...; kwargs...) diff --git a/src/FMI3/comp_wraps.jl b/src/FMI3/comp_wraps.jl index 9ac7c94f..e419f90e 100644 --- a/src/FMI3/comp_wraps.jl +++ b/src/FMI3/comp_wraps.jl @@ -7,17 +7,42 @@ # - wrappers to call fmi3InstanceFunctions from FMUs (FMI-functions, last instantiated instance is used) [exported] # - wrappers to call fmi3InstanceFunctions from FMUs (additional functions, last instantiated instance is used) [exported] -# TODO why is this here? -# using FMIImport: FMU3, fmi3ModelDescription -# using FMIImport: fmi3Float32, fmi3Float64, fmi3Int8, fmi3Int16, fmi3Int32, fmi3Int64, fmi3Boolean, fmi3String, fmi3Binary, fmi3UInt8, fmi3UInt16, fmi3UInt32, fmi3UInt64, fmi3Byte -# using FMIImport: fmi3Clock, fmi3FMUState -# using FMIImport: fmi3CallbackLogger, fmi3CallbackIntermediateUpdate, fmi3CallbackClockUpdate - # fmi-spec +""" + fmi3Simulate(fmu::FMU3, args...; kwargs...) + +Wrapper for `fmi3Simulate(fmu::FMU3, c::Union{FMU3Instance, Nothing}, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets passed as `nothing`) +""" +function fmi3Simulate(fmu::FMU3, args...; kwargs...) + return fmi3Simulate(fmu, nothing, args...; kwargs...) +end + +""" + fmi3SimulateCS(fmu::FMU3, args...; kwargs...) + +Wrapper for `fmi3SimulateCS(fmu::FMU3, c::Union{FMU3Instance, Nothing}, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets passed as `nothing`) +""" +function fmi3SimulateCS(fmu::FMU3, args...; kwargs...) + return fmi3SimulateCS(fmu, nothing, args...; kwargs...) +end + +""" + fmi3SimulateME(fmu::FMU3, args...; kwargs...) + +Wrapper for `fmi3SimulateME(fmu::FMU3, c::Union{FMU3Instance, Nothing}, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets passed as `nothing`) +""" +function fmi3SimulateME(fmu::FMU3, args...; kwargs...) + return fmi3SimulateME(fmu, nothing, args...; kwargs...) +end + """ fmi3FreeInstance!(fmu::FMU3) -Wrapper for fmi3FreeInstance!() in FMIImport/FMI3_c.jl +Wrapper for `fmi3FreeInstance!(c::FMU3Instance; popInstance::Bool = true)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3FreeInstance!(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -27,7 +52,8 @@ end """ fmi3SetDebugLogging(fmu::FMU3) -Wrapper for fmi3SetDebugLogging() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetDebugLogging(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetDebugLogging(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -37,7 +63,8 @@ end """ fmi3EnterInitializationMode(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3EnterInitializationMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EnterInitializationMode(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EnterInitializationMode(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -45,9 +72,10 @@ function fmi3EnterInitializationMode(fmu::FMU3, args...; kwargs...) end """ - fmi3ExitInitializationMode(fmu::FMU2) + fmi3ExitInitializationMode(fmu::FMU3) -Wrapper for fmi3ExitInitializationMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3ExitInitializationMode(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3ExitInitializationMode(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -57,7 +85,8 @@ end """ fmi3Terminate(fmu::FMU3) -Wrapper for fmi3Terminate() in FMIImport/FMI3_c.jl +Wrapper for `fmi3Terminate(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3Terminate(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -67,7 +96,8 @@ end """ fmi3Reset(fmu::FMU3) -Wrapper for fmi3Reset() in FMIImport/FMI3_c.jl +Wrapper for `fmi3Reset(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3Reset(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -77,7 +107,8 @@ end """ fmi3GetFloat32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetFloat32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetFloat32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetFloat32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -87,7 +118,8 @@ end """ fmi3GetFloat32!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetFloat32!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetFloat32!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetFloat32!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -97,7 +129,8 @@ end """ fmi3SetFloat32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetFloat32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetFloat32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetFloat32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -107,7 +140,8 @@ end """ fmi3GetFloat64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetFloat64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetFloat64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetFloat64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -117,7 +151,8 @@ end """ fmi3GetFloat64!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetFloat64!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetFloat64!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetFloat64!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -127,7 +162,8 @@ end """ fmi3SetFloat64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetFloat64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetFloat64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetFloat64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -137,7 +173,8 @@ end """ fmi3GetInt8(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt8() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt8(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt8(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -147,7 +184,8 @@ end """ fmi3GetInt8!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt8!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt8!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt8!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -157,7 +195,8 @@ end """ fmi3SetInt8(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetInt8() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetInt8(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetInt8(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -167,7 +206,8 @@ end """ fmi3GetUInt8(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt8() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt8(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt8(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -177,7 +217,8 @@ end """ fmi3GetUInt8!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt8!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt8!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt8!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -187,7 +228,8 @@ end """ fmi3SetUInt8(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetUInt8() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetUInt8(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetUInt8(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -197,7 +239,8 @@ end """ fmi3GetInt16(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt16() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt16(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt16(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -207,7 +250,8 @@ end """ fmi3GetInt16!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt16!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt16!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt16!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -217,7 +261,8 @@ end """ fmi3SetInt16(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetInt16() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetInt16(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetInt16(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -227,7 +272,8 @@ end """ fmi3GetUInt16(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt16() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt16(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt16(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -237,7 +283,8 @@ end """ fmi3GetUInt16!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt16!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt16!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt16!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -247,7 +294,8 @@ end """ fmi3SetUInt16(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetUInt16() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetUInt16(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetUInt16(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -257,7 +305,8 @@ end """ fmi3GetInt32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -267,7 +316,8 @@ end """ fmi3GetInt32!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt32!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt32!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt32!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -277,7 +327,8 @@ end """ fmi3SetInt32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetInt32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetInt32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetInt32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -287,7 +338,8 @@ end """ fmi3GetUInt32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -297,7 +349,8 @@ end """ fmi3GetUInt32!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt32!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt32!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt32!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -307,7 +360,8 @@ end """ fmi3SetUInt32(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetUInt32() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetUInt32(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetUInt32(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -317,7 +371,8 @@ end """ fmi3GetInt64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -327,7 +382,8 @@ end """ fmi3GetInt64!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetInt64!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetInt64!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetInt64!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -337,7 +393,8 @@ end """ fmi3SetInt64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetInt64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetInt64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetInt64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -347,7 +404,8 @@ end """ fmi3GetUInt64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -357,7 +415,8 @@ end """ fmi3GetUInt64!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetUInt64!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetUInt64!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetUInt64!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -367,7 +426,8 @@ end """ fmi3SetUInt64(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetUInt64() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetUInt64(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetUInt64(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -377,7 +437,8 @@ end """ fmi3GetBoolean(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetBoolean() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetBoolean(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetBoolean(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -387,7 +448,8 @@ end """ fmi3GetBoolean!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetBoolean!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetBoolean!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetBoolean!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -397,7 +459,8 @@ end """ fmi3SetBoolean(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetBoolean!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetBoolean!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetBoolean(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -407,7 +470,8 @@ end """ fmi3GetString(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetString() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetString(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetString(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -417,7 +481,8 @@ end """ fmi3GetString!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetString!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetString!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetString!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -427,7 +492,8 @@ end """ fmi3SetString(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetString() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetString(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetString(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -437,7 +503,8 @@ end """ fmi3GetBinary(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetBinary() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetBinary(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetBinary(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -447,7 +514,8 @@ end """ fmi3GetBinary!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetBinary!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetBinary!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetBinary!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -457,7 +525,8 @@ end """ fmi3SetBinary(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetBinary() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetBinary(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetBinary(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -467,7 +536,8 @@ end """ fmi3GetClock(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetClock() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetClock(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetClock(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -477,7 +547,8 @@ end """ fmi3GetClock!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetClock!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetClock!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetClock!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -487,7 +558,8 @@ end """ fmi3SetClock(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetClock() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SetClock(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetClock(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -497,7 +569,8 @@ end """ fmiGet(fmu::FMU3, args...; kwargs...) -Wrapper for fmiGet() in FMIImport/FMI3_ext.jl +Wrapper for `fmiGet(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmiGet(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -507,7 +580,8 @@ end """ fmiGet!(fmu::FMU3, args...; kwargs...) -Wrapper for fmiGet!() in FMIImport/FMI3_ext.jl +Wrapper for `fmiGet!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmiGet!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -517,7 +591,8 @@ end """ fmiSet(fmu::FMU3, args...; kwargs...) -Wrapper for fmiSet() in FMIImport/FMI3_ext.jl +Wrapper for `fmiSet(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmiSet(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -527,7 +602,8 @@ end """ fmi3GetFMUstate(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetFMUstate() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetFMUstate(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetFMUState(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -537,7 +613,8 @@ end """ fmi3SetFMUstate(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetFMUstate() in FMIImport/FMI3_c.jl +Wrapper for `fmi3SetFMUstate(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetFMUState(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -547,7 +624,8 @@ end """ fmi3FreeFMUState!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3FreeFMUState!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3FreeFMUState!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3FreeFMUState!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -557,7 +635,8 @@ end """ fmi3SerializedFMUStateSize(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SerializedFMUStateSize() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SerializedFMUStateSize(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SerializedFMUStateSize(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -567,7 +646,8 @@ end """ fmi3SerializeFMUState(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SerializeFMUState() in FMIImport/FMI3_int.jl +Wrapper for `fmi3SerializeFMUState(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SerializeFMUState(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -577,7 +657,8 @@ end """ fmi3DeSerializeFMUState(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3DeSerializeFMUState() in FMIImport/FMI3_int.jl +Wrapper for `fmi3DeSerializeFMUState(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3DeSerializeFMUState(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -587,7 +668,8 @@ end """ fmi3GetDirectionalDerivative(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetDirectionalDerivative() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetDirectionalDerivative(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetDirectionalDerivative(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -597,7 +679,8 @@ end """ fmi3GetDirectionalDerivative!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetDirectionalDerivative!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetDirectionalDerivative!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetDirectionalDerivative!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -607,7 +690,8 @@ end """ fmi3GetAdjointDerivative(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetAdjointDerivative() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetAdjointDerivative(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetAdjointDerivative(fmu::FMU3, args...; kwargs...) @@ -618,7 +702,8 @@ end """ fmi3GetAdjointDerivative!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetAdjointDerivative!() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetAdjointDerivative!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetAdjointDerivative!(fmu::FMU3, args...; kwargs...) @@ -629,7 +714,8 @@ end """ fmi3SampleDirectionalDerivative!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SampleDirectionalDerivative!() in FMIImport/FMI3_ext.jl +Wrapper for `fmi3SampleDirectionalDerivative!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SampleDirectionalDerivative!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -639,7 +725,8 @@ end """ fmi3SampleDirectionalDerivative(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SampleDirectionalDerivative() in FMIImport/FMI3_ext.jl +Wrapper for `fmi3SampleDirectionalDerivative(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SampleDirectionalDerivative(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -649,7 +736,8 @@ end """ fmi3GetJacobian!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetJacobian!() in FMIImport/FMI3_ext.jl +Wrapper for `fmi3GetJacobian!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetJacobian!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -659,7 +747,8 @@ end """ fmi3GetJacobian(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetJacobian() in FMIImport/FMI3_ext.jl +Wrapper for `fmi3GetJacobian(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetJacobian(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -669,7 +758,8 @@ end """ fmi3GetOutputDerivatives(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetOutputDerivatives() in FMIImport/FMI3_int.jl +Wrapper for `fmi3GetOutputDerivatives(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetOutputDerivatives(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -679,7 +769,8 @@ end """ fmi3EnterConfigurationMode(fmu::FMU3) -Wrapper for fmi3EnterConfigurationMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EnterConfigurationMode(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EnterConfigurationMode(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -689,7 +780,8 @@ end """ fmi3GetNumberOfContinuousStates(fmu::FMU3) -Wrapper for fmi3GetNumberOfContinuousStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetNumberOfContinuousStates(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetNumberOfContinuousStates(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -699,7 +791,8 @@ end """ fmi3GetNumberOfVariableDependencies(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetNumberOfVariableDependencies() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetNumberOfVariableDependencies(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetNumberOfVariableDependencies(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -709,7 +802,8 @@ end """ fmi3GetVariableDependencies(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetVariableDependencies() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetVariableDependencies(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetVariableDependencies(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -719,7 +813,8 @@ end """ fmi3GetContinuousStates(fmu::FMU3) -Wrapper for fmi3GetContinuousStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetContinuousStates(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetContinuousStates(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -729,7 +824,8 @@ end """ fmi3GetNominalsOfContinuousStates(fmu::FMU3) -Wrapper for fmi3GetNominalsOfContinuousStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetNominalsOfContinuousStates(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetNominalsOfContinuousStates(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -739,7 +835,8 @@ end """ fmi3EvaluateDiscreteStates(fmu::FMU3) -Wrapper for fmi3EvaluateDiscreteStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EvaluateDiscreteStates(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EvaluateDiscreteStates(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -749,7 +846,8 @@ end """ fmi3UpdateDiscreteStates(fmu::FMU3) -Wrapper for fmi3UpdateDiscreteStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3UpdateDiscreteStates(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3UpdateDiscreteStates(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -759,7 +857,8 @@ end """ fmi3EnterContinuousTimeMode(fmu::FMU3) -Wrapper for fmi3EnterContinuousTimeMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EnterContinuousTimeMode(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EnterContinuousTimeMode(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -769,7 +868,8 @@ end """ fmi3EnterStepMode(fmu::FMU3) -Wrapper for fmi3EnterStepMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EnterStepMode(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EnterStepMode(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -779,7 +879,8 @@ end """ fmi3ExitConfigurationMode(fmu::FMU3) -Wrapper for fmi3ExitConfigurationMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3ExitConfigurationMode(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3ExitConfigurationMode(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -789,7 +890,8 @@ end """ fmi3SetTime(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetTime() in FMIImport/FMI3_c.jl +Wrapper for `fmi3SetTime(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetTime(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -799,7 +901,8 @@ end """ fmi3SetContinuousStates(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3SetContinuousStates() in FMIImport/FMI3_c.jl +Wrapper for `fmi3SetContinuousStates(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3SetContinuousStates(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -809,7 +912,8 @@ end """ fmi3GetContinuousStateDerivatives(fmu::FMU3) -Wrapper for fmi3GetContinuousStateDerivatives() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetContinuousStateDerivatives(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetContinuousStateDerivatives(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -819,7 +923,8 @@ end """ fmi3GetEventIndicators(fmu::FMU3) -Wrapper for fmi3GetEventIndicators() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetEventIndicators(c::FMU3Instance)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetEventIndicators(fmu::FMU3) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -829,7 +934,8 @@ end """ fmi3CompletedIntegratorStep(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3CompletedIntegratorStep() in FMIImport/FMI3_c.jl +Wrapper for `fmi3CompletedIntegratorStep(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3CompletedIntegratorStep(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -839,7 +945,8 @@ end """ fmi3EnterEventMode(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3EnterEventMode() in FMIImport/FMI3_c.jl +Wrapper for `fmi3EnterEventMode(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3EnterEventMode(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] @@ -849,46 +956,20 @@ end """ fmi3DoStep!(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3DoStep!() in FMIImport/FMI3_c.jl +Wrapper for `fmi3DoStep!(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3DoStep!(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"] fmi3DoStep!(fmu.instances[end], args...; kwargs...) end -#additional -""" - fmi3Simulate(fmu::FMU3, args...; kwargs...) - -Wrapper for fmi3Simulate() in FMI/FMI3_sim.jl -""" -function fmi3Simulate(fmu::FMU3, args...; kwargs...) - fmi3Simulate(fmu, nothing, args...; kwargs...) -end - -""" - fmi3SimulateCS(fmu::FMU3, args...; kwargs...) - -Wrapper for fmi3SimulateCS() in FMI/FMI3_sim.jl -""" -function fmi3SimulateCS(fmu::FMU3, args...; kwargs...) - return fmi3SimulateCS(fmu, nothing, args...; kwargs...) -end - -""" - fmi3SimulateME(fmu::FMU3, args...; kwargs...) - -Wrapper for fmi3SimulateME() in FMI/FMI3_sim.jl -""" -function fmi3SimulateME(fmu::FMU3, args...; kwargs...) - return fmi3SimulateME(fmu, nothing, args...; kwargs...) -end - """ fmi3GetStartValue(fmu::FMU3, args...; kwargs...) -Wrapper for fmi3GetStartValue() in FMIImport/FMI3_c.jl +Wrapper for `fmi3GetStartValue(c::FMU3Instance, args...; kwargs...)` without a provided FMU3Instance. +(Instance `c` gets selected from `fmu`) """ function fmi3GetStartValue(fmu::FMU3, args...; kwargs...) @assert length(fmu.instances) > 0 ["No FMU instance allocated, have you already called fmiInstantiate?"]