FMI Common Concepts for Model Exchange and Co-Simulation

In both cases, FMI defines an input/output block of a dynamic model where the distribution of the block, the platform dependent header file, several access functions, as well as the schema files are identical.

Creation, Destruction and Logging of FMU Instances

FMICore.fmi3InstantiateCoSimulation — Function

Source: FMISpec3.0, Version D5ef1c1:: 2.3.1. Super State: FMU State Setable

This function instantiates a Co-Simulation FMU (see Section 4). It is allowed to call this function only if modelDescription.xml includes a <CoSimulation> element.

FMIImport.fmi3InstantiateCoSimulation! — Function

fmi3InstantiateCoSimulation!(fmu::FMU3; instanceName::String=fmu.modelName, type::fmi3Type=fmu.type, pushInstances::Bool = true, visible::Bool = false, loggingOn::Bool = fmu.executionConfig.loggingOn, externalCallbacks::Bool = fmu.executionConfig.externalCallbacks, 
    eventModeUsed::Bool = false, ptrIntermediateUpdate=nothing, logStatusOK::Bool=true, logStatusWarning::Bool=true, logStatusDiscard::Bool=true, logStatusError::Bool=true, logStatusFatal::Bool=true)

Create a new coSimulation instance of the given fmu, adds a logger if logginOn == true.

Arguments

fmu::FMU3: Mutable struct representing a FMU and all it instantiated instances in the FMI 3.0 Standard.

Keywords

instanceName::String=fmu.modelName: Name of the instance
type::fmi3Type=fmu.type: Defines whether a Co-Simulation or Model Exchange is present
pushInstances::Bool = true: Defines if the fmu instances should be pushed in the application.
visible::Bool = false if the FMU should be started with graphic interface, if supported (default=false)
loggingOn::Bool = fmu.executionConfig.loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks::Bool = fmu.executionConfig.externalCallbacks if an external shared library should be used for the fmi3CallbackFunctions, this may improve readability of logging messages (default=false)
eventModeUsed::Bool = false: Defines if the FMU instance can use the event mode. (default=false)
ptrIntermediateUpdate=nothing: Points to a function handling intermediate Updates (defalut=nothing)
logStatusOK::Bool=true whether to log status of kind fmi3OK (default=true)
logStatusWarning::Bool=true whether to log status of kind fmi3Warning (default=true)
logStatusDiscard::Bool=true whether to log status of kind fmi3Discard (default=true)
logStatusError::Bool=true whether to log status of kind fmi3Error (default=true)
logStatusFatal::Bool=true whether to log status of kind fmi3Fatal (default=true)

Returns

Returns the instance of a new FMU coSimulation instance.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.4.7 Model variables
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3InstantiateCoSimulation.

FMICore.fmi3InstantiateModelExchange — Function

Source: FMISpec3.0, Version D5ef1c1:: 2.3.1. Super State: FMU State Setable

This function instantiates a Model Exchange FMU (see Section 3). It is allowed to call this function only if modelDescription.xml includes a <ModelExchange> element.

FMIImport.fmi3InstantiateModelExchange! — Function

fmi3InstantiateModelExchange!(fmu::FMU3; instanceName::String=fmu.modelName, type::fmi3Type=fmu.type, pushInstances::Bool = true, visible::Bool = false, loggingOn::Bool = fmu.executionConfig.loggingOn, externalCallbacks::Bool = fmu.executionConfig.externalCallbacks,
    logStatusOK::Bool=true, logStatusWarning::Bool=true, logStatusDiscard::Bool=true, logStatusError::Bool=true, logStatusFatal::Bool=true)

Create a new modelExchange instance of the given fmu, adds a logger if logginOn == true.

Arguments

fmu::FMU3: Mutable struct representing a FMU and all it instantiated instances in the FMI 3.0 Standard.

Keywords

instanceName::String=fmu.modelName: Name of the instance
type::fmi3Type=fmu.type: Defines whether a Co-Simulation or Model Exchange is present
pushInstances::Bool = true: Defines if the fmu instances should be pushed in the application.
visible::Bool = false if the FMU should be started with graphic interface, if supported (default=false)
loggingOn::Bool = fmu.executionConfig.loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks::Bool = fmu.executionConfig.externalCallbacks if an external shared library should be used for the fmi3CallbackFunctions, this may improve readability of logging messages (default=false)
logStatusOK::Bool=true whether to log status of kind fmi3OK (default=true)
logStatusWarning::Bool=true whether to log status of kind fmi3Warning (default=true)
logStatusDiscard::Bool=true whether to log status of kind fmi3Discard (default=true)
logStatusError::Bool=true whether to log status of kind fmi3Error (default=true)
logStatusFatal::Bool=true whether to log status of kind fmi3Fatal (default=true)

Returns

Returns the instance of a new FMU modelExchange instance.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.4.7 Model variables
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3InstantiateModelExchange.

FMICore.fmi3InstantiateScheduledExecution — Function

Source: FMISpec3.0, Version D5ef1c1:: 2.3.1. Super State: FMU State Setable

This function instantiates a Scheduled Execution FMU (see Section 4). It is allowed to call this function only if modelDescription.xml includes a <ScheduledExecution> element.

FMIImport.fmi3InstantiateScheduledExecution! — Function

fmi3InstantiateScheduledExecution!(fmu::FMU3; ptrlockPreemption::Ptr{Cvoid}, ptrunlockPreemption::Ptr{Cvoid}, instanceName::String=fmu.modelName, type::fmi3Type=fmu.type, pushInstances::Bool = true, visible::Bool = false, loggingOn::Bool = fmu.executionConfig.loggingOn, externalCallbacks::Bool = fmu.executionConfig.externalCallbacks, 
    logStatusOK::Bool=true, logStatusWarning::Bool=true, logStatusDiscard::Bool=true, logStatusError::Bool=true, logStatusFatal::Bool=true)

Create a new ScheduledExecution instance of the given fmu, adds a logger if logginOn == true.

Arguments

fmu::FMU3: Mutable struct representing a FMU and all it instantiated instances in the FMI 3.0 Standard.

Keywords

ptrlockPreemption::Ptr{Cvoid}: Points to a function handling locking Preemption
ptrunlockPreemption::Ptr{Cvoid}: Points to a function handling unlocking Preemption
instanceName::String=fmu.modelName: Name of the instance
type::fmi3Type=fmu.type: Defines whether a Co-Simulation or Model Exchange is present
pushInstances::Bool = true: Defines if the fmu instances should be pushed in the application.
visible::Bool = false if the FMU should be started with graphic interface, if supported (default=false)
loggingOn::Bool = fmu.executionConfig.loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks::Bool = fmu.executionConfig.externalCallbacks if an external shared library should be used for the fmi3CallbackFunctions, this may improve readability of logging messages (default=false)
logStatusOK::Bool=true whether to log status of kind fmi3OK (default=true)
logStatusWarning::Bool=true whether to log status of kind fmi3Warning (default=true)
logStatusDiscard::Bool=true whether to log status of kind fmi3Discard (default=true)
logStatusError::Bool=true whether to log status of kind fmi3Error (default=true)
logStatusFatal::Bool=true whether to log status of kind fmi3Fatal (default=true)

Returns

Returns the instance of a new FMU ScheduledExecution instance.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.4.7 Model variables
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3InstantiateScheduledExecution.

FMICore.fmi3FreeInstance — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

Disposes the given instance, unloads the loaded model, and frees all the allocated memory and other resources that have been allocated by the functions of the FMU interface. If a NULL pointer is provided for argument instance, the function call is ignored (does not have an effect).

FMIImport.fmi3FreeInstance! — Function

fmi3FreeInstance!(c::FMU3Instance; popInstance::Bool = true)

Disposes the given instance, unloads the loaded model, and frees all the allocated memory and other resources that have been allocated by the functions of the FMU interface. If a null pointer is provided for “c”, the function call is ignored (does not have an effect).

Removes the component from the FMUs component list.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Keywords

popInstance::Bool=true: If the Keyword popInstance = true the freed instance is deleted

Returns

nothing

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

FMICore.fmi3SetDebugLogging — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

The function controls debug logging that is output via the logger function callback. If loggingOn = fmi3True, debug logging is enabled, otherwise it is switched off.

fmi3SetDebugLogging(c::FMU3Instance, logginOn::fmi3Boolean, nCategories::UInt, categories::Ptr{Nothing})

Control the use of the logging callback function, version independent.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
logginOn::fmi3Boolean: If loggingOn = fmi3True, debug logging is enabled for the log categories specified in categories, otherwise it is disabled. Type fmi3Boolean is defined as an alias Type for the C-Type Boolean and is to be used with fmi3True and fmi3False.
nCategories::UInt: Argument nCategories defines the length of the argument categories.
categories::Ptr{Nothing}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3SetDebugLogging.

fmi3SetDebugLogging(c::FMU3Instance)

Set the DebugLogger for the FMU.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

Returns a warning if str.state is not called in fmi3InstanceStateInstantiated.
status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3SetDebugLogging.

Initialization, Termination, and Resetting an FMU

This section documents functions that deal with initialization, termination, resetting of an FMU.

FMICore.fmi3EnterInitializationMode — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

Informs the FMU to enter Initialization Mode. Before calling this function, all variables with attribute <Datatype initial = "exact" or "approx"> can be set with the “fmi3SetXXX” functions (the ScalarVariable attributes are defined in the Model Description File, see section 2.4.7). Setting other variables is not allowed. Also sets the simulation start and stop time.

fmi3EnterInitializationMode(c::FMU3Instance, toleranceDefined::fmi3Boolean,
    tolerance::fmi3Float64,
    startTime::fmi3Float64,
    stopTimeDefined::fmi3Boolean,
    stopTime::fmi3Float64)

Informs the FMU to enter Initialization Mode. Before calling this function, all variables with attribute <Datatype initial = "exact" or "approx"> can be set with the “fmi3SetXXX” functions (the ScalarVariable attributes are defined in the Model Description File, see section 2.4.7). Setting other variables is not allowed. Also sets the simulation start and stop time.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
toleranceDefined::fmi3Boolean: Arguments toleranceDefined depend on the FMU type:
- fmuType = fmi3ModelExchange: If toleranceDefined = fmi3True, then the model is called with a numerical integration scheme where the step size is controlled by using tolerance for error estimation. In such a case, all numerical algorithms used inside the model (for example, to solve non-linear algebraic equations) should also operate with an error estimation of an appropriate smaller relative tolerance.
- fmuType = fmi3CoSimulation: If toleranceDefined = fmi3True, then the communication interval of the slave is controlled by error estimation. In case the slave utilizes a numerical integrator with variable step size and error estimation, it is suggested to use “tolerance” for the error estimation of the internal integrator (usually as relative tolerance). An FMU for Co-Simulation might ignore this argument.
tolerance::fmi3Float64: Argument tolerance is the desired tolerance
startTime::fmi3Float64: Argument startTime can be used to check whether the model is valid within the given boundaries or to allocate memory which is necessary for storing results. It is the fixed initial value of the independent variable and if the independent variable is time, startTime is the starting time of initializaton.
stopTimeDefined::fmi3Boolean: If stopTimeDefined = fmi3True, then stopTime is the defined final value of the independent variable and if stopTimeDefined = fmi3False, then no final value

of the independent variable is defined and argument stopTime is meaningless.

stopTime::fmi3Float64: Argument stopTime can be used to check whether the model is valid within the given boundaries or to allocate memory which is necessary for storing results. It is the fixed final value of the independent variable and if the independent variable is “time”, stopTime is the stop time of the simulation.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.2. State: Instantiated

See also fmi3EnterInitializationMode.

fmi3EnterInitializationMode(c::FMU3Instance, startTime::Union{Real, Nothing} = nothing, stopTime::Union{Real, Nothing} = nothing; tolerance::Union{Real, Nothing} = nothing)

FMU enters Initialization mode.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
startTime::Union{Real, Nothing} = nothing: startTime is a real number which sets the value of starting time of the experiment. The default value is set automatically if doing nothing (default = nothing).
stopTime::Union{Real, Nothing} = nothing: stopTime is a real number which sets the value of ending time of the experiment. The default value is set automatically if doing nothing (default = nothing).

Keywords

tolerance::Union{Real, Nothing} = nothing: tolerance is a real number which sets the value of tolerance range. The default value is set automatically if doing nothing (default = nothing).

Returns

Returns a warning if str.state is not called in fmi3InstanceStateInstantiated.
status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.2. State: Instantiated

See also fmi3EnterInitializationMode.

FMICore.fmi3ExitInitializationMode — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Informs the FMU to exit Initialization Mode.

fmi3ExitInitializationMode(c::FMU3Instance)

Informs the FMU to exit Initialization Mode.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.3. State: Initialization Mode

See also fmi3ExitInitializationMode.

FMICore.fmi3EnterConfigurationMode — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

If the importer needs to change structural parameters, it must move the FMU into Configuration Mode using fmi3EnterConfigurationMode.

fmi3EnterConfigurationMode(c::FMU3Instance; soft::Bool=false)

If the importer needs to change structural parameters, it must move the FMU into Configuration Mode using fmi3EnterConfigurationMode.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Keywords

soft::Bool=false: If the Keyword soft = true the fmi3Teminate needs to be called in state fmi3InstanceStateContinuousTimeMode or fmi3InstanceStateEventMode.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.2. State: Instantiated

See also fmi3EnterConfigurationMode.

FMICore.fmi3ExitConfigurationMode — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.6. State: Configuration Mode

Exits the Configuration Mode and returns to state Instantiated.

fmi3ExitConfigurationMode(c::FMU3Instance; soft::Bool=false)

Exits the Configuration Mode and returns to state Instantiated.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Keywords

soft::Bool=false: If the Keyword soft = true the fmi3Teminate needs to be called in state fmi3InstanceStateContinuousTimeMode or fmi3InstanceStateEventMode.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.6. State: Configuration Mode

See also fmi3ExitConfigurationMode.

FMICore.fmi3Terminate — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.4. Super State: Initialized

Informs the FMU that the simulation run is terminated.

fmi3Terminate(c::FMU3Instance; soft::Bool=false)

Informs the FMU that the simulation run is terminated.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Keywords

soft::Bool=false: If the Keyword soft = true the fmi3Teminate needs to be called in state fmi3InstanceStateContinuousTimeMode or fmi3InstanceStateEventMode.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.4. Super State: Initialized

See also fmi3Terminate.

FMICore.fmi3Reset — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

Is called by the environment to reset the FMU after a simulation run. The FMU goes into the same state as if fmi3InstantiateXXX would have been called.

fmi3Reset(c::FMU3Instance; soft::Bool = false)

Is called by the environment to reset the FMU after a simulation run. The FMU goes into the same state as if fmi3InstantiateXXX would have been called.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Keywords

soft::Bool=false: If the Keyword soft = true the fmi3Teminate needs to be called in state fmi3InstanceStateContinuousTimeMode or fmi3InstanceStateEventMode.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.1. Super State: FMU State Setable

See also fmi3Reset.

Getting and Setting Variable Values

All variable values of an FMU are identified with a variable handle called “value reference”. The handle is defined in the modelDescription.xml file (as attribute “valueReference” in element “ScalarVariable”). Element “valueReference” might not be unique for all variables. If two or more variables of the same base data type (such as fmi3Float64) have the same valueReference, then they have identical values but other parts of the variable definition might be different (for example, min/max attributes).

FMIImport.fmi3GetFloat32 — Function

fmi3GetFloat32(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Float32 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Float32}: returns values of an array of fmi3Float32 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat32.

FMICore.fmi3GetFloat32! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetFloat32!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Float32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Float32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat32!.

fmi3GetFloat32!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Float32})

Writes the real values of an array of variables in the given field

fmi3GetFloat32! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Float32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat32!.

FMIImport.fmi3GetFloat64 — Function

fmi3GetFloat64(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Float64 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Float64}: returns values of an array of fmi3Float64 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat64.

FMICore.fmi3GetFloat64! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetFloat64!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Float64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Float64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat64!.

fmi3GetFloat64!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Float64})

Writes the real values of an array of variables in the given field

fmi3GetFloat64! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Float64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetFloat64!.

FMIImport.fmi3GetInt8 — Function

fmi3GetInt8(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Int8 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Int8}: returns values of an array of fmi3Int8 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt8.

FMICore.fmi3GetInt8! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetInt8!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int8}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int8}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt8!.

fmi3GetInt8!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Int8})

Writes the integer values of an array of variables in the given field

fmi3GetInt8! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Int8}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt8!.

FMIImport.fmi3GetInt16 — Function

fmi3GetInt16(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Int16 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Int16}: returns values of an array of fmi3Int16 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt16.

FMICore.fmi3GetInt16! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetInt16!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int16}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int16}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt16!.

fmi3GetInt16!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Int16})

Writes the integer values of an array of variables in the given field

fmi3GetInt16! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Int16}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt16!.

FMIImport.fmi3GetInt32 — Function

fmi3GetInt32(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Int32 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Int32}: returns values of an array of fmi3Int32 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt32.

FMICore.fmi3GetInt32! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetInt32!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt32!.

fmi3GetInt32!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Int32})

Writes the integer values of an array of variables in the given field

fmi3GetInt32! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Int32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt32!.

FMIImport.fmi3GetInt64 — Function

fmi3GetInt64(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Int64 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Int64}: returns values of an array of fmi3Int64 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt64.

FMICore.fmi3GetInt64! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetInt64!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt64!.

fmi3GetInt64!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Int64})

Writes the integer values of an array of variables in the given field

fmi3GetInt64! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Int64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetInt64!.

FMIImport.fmi3GetUInt8 — Function

fmi3GetUInt8(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3UInt8 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3UInt8}: returns values of an array of fmi3UInt8 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt8.

FMICore.fmi3GetUInt8! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetUInt8!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt8}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt8}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt8!.

fmi3GetUInt8!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3UInt8})

Writes the integer values of an array of variables in the given field

fmi3GetUInt8! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3UInt8}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt8!.

FMIImport.fmi3GetUInt16 — Function

fmi3GetUInt16(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3UInt16 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3UInt16}: returns values of an array of fmi3UInt16 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt16.

FMICore.fmi3GetUInt16! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetUInt16(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt16}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt16}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt16!.

fmi3GetUInt16!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3UInt16})

Writes the integer values of an array of variables in the given field

fmi3GetUInt16! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3UInt16}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt16!.

FMIImport.fmi3GetUInt32 — Function

fmi3GetUInt32(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3UInt32 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3UInt32}: returns values of an array of fmi3UInt32 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt32.

FMICore.fmi3GetUInt32! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetUInt32!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt32!.

fmi3GetUInt32!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3UInt32})

Writes the integer values of an array of variables in the given field

fmi3GetUInt32! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3UInt32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt32!.

FMIImport.fmi3GetUInt64 — Function

fmi3GetUInt64(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3UInt64 variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3UInt64}: returns values of an array of fmi3UInt64 variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt64.

FMICore.fmi3GetUInt64! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetUInt64!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt64!.

fmi3GetUInt64!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3UInt64})

Writes the integer values of an array of variables in the given field

fmi3GetUInt64! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3UInt64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetUInt64!.

FMIImport.fmi3GetBoolean — Function

fmi3GetBoolean(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Boolean variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Boolean}: returns values of an array of fmi3Boolean variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBoolean.

FMICore.fmi3GetBoolean! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetBoolean!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Boolean}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Boolean}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBoolean!.

fmi3GetBoolean!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Boolean})

Writes the boolean values of an array of variables in the given field

fmi3GetBoolean! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Boolean}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBoolean!.

FMIImport.fmi3GetString — Function

fmi3GetString(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3String variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3String}: returns values of an array of fmi3String variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetString.

FMICore.fmi3GetString! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetString!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3String}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3String}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetString!.

fmi3GetString!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3String})

Writes the string values of an array of variables in the given field

fmi3GetString! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3String}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetString!.

FMIImport.fmi3GetBinary — Function

fmi3GetBinary(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Binary variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Binary}: returns values of an array of fmi3Binary variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBinary.

FMICore.fmi3GetBinary! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValues - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetBinary!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, valueSizes::AbstractArray{Csize_t}, value::AbstractArray{fmi3Binary}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
valueSizes::AbstractArray{Csize_t}: Argument valueSizes defines the size of a binary element of each variable.
value::AbstractArray{fmi3Binary}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBinary!.

fmi3GetBinary!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Binary})

Writes the binary values of an array of variables in the given field

fmi3GetBinary! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Binary}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetBinary!.

FMICore.fmi3SetFloat32 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetFloat32(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Float32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Float32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetFloat32.

fmi3SetFloat32(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Float32}, fmi3Float32})

Set the values of an array of real variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Float32}, fmi3Float32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetFloat32.

FMICore.fmi3SetFloat64 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetFloat64(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Float64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Float64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetFloat64.

fmi3SetFloat64(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Float64}, fmi3Float64})

Set the values of an array of real variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Float64}, fmi3Float64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetFloat64.

FMICore.fmi3SetInt8 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetInt8(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int8}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int8}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

fmi3SetInt8(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Int8}, fmi3Int8})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Int8}, fmi3Int8}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt8.

FMICore.fmi3SetInt16 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetInt16(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int16}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int16}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt16.

fmi3SetInt16(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Int16}, fmi3Int16})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Int16}, fmi3Int16}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt16.

FMICore.fmi3SetInt32 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetInt32(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt32.

fmi3SetInt32(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Int32}, fmi3Int32})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Int32}, fmi3Int32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt32.

FMICore.fmi3SetInt64 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetInt64(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Int64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Int64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt64.

fmi3SetInt64(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3Int64}, fmi3Int64})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Int64}, fmi3Int64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetInt64.

FMICore.fmi3SetUInt8 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetUInt8(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt8}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt8}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt8.

fmi3SetUInt8(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3UInt8}, fmi3UInt8})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3UInt8}, fmi3UInt8}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt8.

FMICore.fmi3SetUInt16 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetUInt16(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt16}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt16}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

fmi3SetUInt16(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3UInt16}, fmi3UInt16})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3UInt16}, fmi3UInt16}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt16.

FMICore.fmi3SetUInt32 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetInt32(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt32}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt32}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt32.

fmi3SetUInt32(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3UInt32}, fmi3UInt32})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3UInt32}, fmi3UInt32}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt32.

FMICore.fmi3SetUInt64 — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetUInt64(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3UInt64}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3UInt64}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed: - fmi3OK: all well - fmi3Warning: things are not quite right, but the computation can continue - fmi3Discard: if the slave computed successfully only a subinterval of the communication step - fmi3Error: the communication step could not be carried out at all - fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt64.

fmi3SetUInt64(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{fmi3UInt64}, fmi3UInt64})

Set the values of an array of integer variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3UInt64}, fmi3UInt64}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetUInt64.

FMICore.fmi3SetBoolean — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetBoolean(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Boolean}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3Boolean}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetBoolean.

fmi3SetBoolean(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{Bool}, Bool})

Set the values of an array of boolean variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{Bool}, Bool}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetBoolean.

FMICore.fmi3SetString — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetString(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3String}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::AbstractArray{fmi3String}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetString.

fmi3SetString(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::Union{AbstractArray{String}, String})

Set the values of an array of string variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{String}, String}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetString.

FMICore.fmi3SetBinary — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetBinary(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, valueSizes::AbstractArray{Csize_t}, value::AbstractArray{fmi3Binary}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
valueSizes::AbstractArray{Csize_t}: Argument valueSizes defines the size of a binary element of each variable.
value::AbstractArray{fmi3Binary}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetBinary.

fmi3SetBinary(c::FMU3Instance, vr::fmi3ValueReferenceFormat, valueSizes::Union{AbstractArray{Csize_t}, Csize_t}, values::Union{AbstractArray{fmi3Binary}, fmi3Binary})

Set the values of an array of binary variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

valueSizes::Union{AbstractArray{Csize_t}, Csize_t}: Argument valueSizes defines the size of a binary element of each variable.
values::Union{AbstractArray{fmi3Binary}, fmi3Binary}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetBinary.

fmi3Get fmi3Get! fmi3Set

Getting and Setting the Complete FMU State

The FMU has an internal state consisting of all values that are needed to continue a simulation. This internal state consists especially of the values of the continuous-time states, iteration variables, parameter values, input values, delay buffers, file identifiers, and FMU internal status information. With the functions of this section, the internal FMU state can be copied and the pointer to this copy is returned to the environment. The FMU state copy can be set as actual FMU state, in order to continue the simulation from it.

FMIImport.fmi3GetFMUState — Function

fmi3GetFMUState(c::FMU3Instance)

Makes a copy of the internal FMU state and returns a pointer to this copy.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

Return state is a pointer to a copy of the internal FMU state.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3GetFMUState.

FMICore.fmi3GetFMUState! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3GetFMUstate makes a copy of the internal FMU state and returns a pointer to this copy

fmi3GetFMUState!(c::FMU3Instance, FMUstate::Ref{fmi3FMUState})

Makes a copy of the internal FMU state and returns a pointer to this copy

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::Ref{fmi3FMUstate}:If on entry FMUstate == NULL, a new allocation is required. If FMUstate != NULL, then FMUstate points to a previously returned FMUstate that has not been modified since.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3GetFMUState!.

FMICore.fmi3SetFMUState — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SetFMUstate copies the content of the previously copied FMUstate back and uses it as actual new FMU state.

fmi3SetFMUState(c::FMU3Instance, FMUstate::fmi3FMUState)

Copies the content of the previously copied FMUstate back and uses it as actual new FMU state.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::fmi3FMUstate: Argument FMUstate is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3SetFMUState.

FMICore.fmi3FreeFMUState — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3FreeFMUstate frees all memory and other resources allocated with the fmi3GetFMUstate call for this FMUstate.

fmi3FreeFMUState(c::FMU3Instance, FMUstate::Ref{fmi3FMUState})

Frees all memory and other resources allocated with the fmi3GetFMUstate call for this FMUstate.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::fmi3FMUstate: Argument FMUstate is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3FreeFMUState!(c::FMU3Instance, state::fmi3FMUState)

Free the allocated memory for the FMU state.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
state::fmi3FMUState: Argument state is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

Return singleton instance of type Nothing, if there is no value to return (as in a C void function) or when a variable or field holds no value.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

FMIImport.fmi3SerializeFMUState — Function

fmi3SerializeFMUState(c::FMU3Instance, state::fmi3FMUState)

Serializes the data referenced by the pointer FMUstate and copies this data into the byte vector serializedState of length size to be provided by the environment.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
state::fmi3FMUState: Argument state is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

serializedState:: Array{fmi3Byte}: Return serializedState contains the copy of the serialized data referenced by the pointer FMUstate

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3SerializeFMUState.

FMICore.fmi3SerializeFMUState! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SerializeFMUstate serializes the data which is referenced by pointer FMUstate and copies this data in to the byte vector serializedState of length size

fmi3SerializeFMUState!(c::FMU3Instance, FMUstate::fmi3FMUState, serialzedState::AbstractArray{fmi3Byte}, size::Csize_t)

Serializes the data which is referenced by pointer FMUState and copies this data in to the byte vector serializedState of length size, that must be provided by the environment.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::fmi3FMUstate: Argument FMUstate is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.
serialzedState::AbstractArray{fmi3Byte}: Argument serializedState contains the copy of the serialized data referenced by the pointer FMUstate.
size::Ref{Csize_t}: Argument size is an object that safely references a value of type Csize_t and defines the size of the byte vector in which the FMUstate can be stored.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3SerializeFMUState!.

FMIImport.fmi3SerializedFMUStateSize — Function

fmi3SerializedFMUStateSize(c::FMU3Instance, state::fmi3FMUState)

Returns the size of the byte vector in which the FMUstate can be stored.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
state::fmi3FMUState: Argument state is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

Return size is an object that safely references a value of type Csize_t.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3SerializedFMUStateSize.

FMICore.fmi3SerializedFMUStateSize! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SerializedFMUstateSize returns the size of the byte vector which is needed to store FMUstate in it.

fmi3SerializedFMUStateSize!(c::FMU3Instance, FMUstate::fmi3FMUState, size::Ref{Csize_t})

Frees all memory and other resources allocated with the fmi3GetFMUstate call for this FMUstate.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::fmi3FMUstate: Argument FMUstate is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.
size::Ref{Csize_t}: Argument size is an object that safely references a value of type Csize_t and defines the size of the byte vector in which the FMUstate can be stored.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3SerializedFMUStateSize!.

FMIImport.fmi3DeSerializeFMUState — Function

fmi3SerializeFMUState(c::FMU3Instance, state::fmi3FMUState)

Serializes the data referenced by the pointer FMUstate and copies this data into the byte vector serializedState of length size to be provided by the environment.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
serializedState::Array{fmi3Byte}: Argument serializedState contains the fmi3Byte field to be deserialized.

Returns

Return state is a pointer to a copy of the internal FMU state.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3DeSerializeFMUState.

FMICore.fmi3DeSerializeFMUState! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3DeSerializeFMUstate deserializes the byte vector serializedState of length size, constructs a copy of the FMU state and returns FMUstate, the pointer to this copy.

fmi3DeSerializeFMUState!(c::FMU3Instance, serialzedState::AbstractArray{fmi3Byte}, size::Csize_t, FMUstate::Ref{fmi3FMUState})

Deserializes the byte vector serializedState of length size, constructs a copy of the FMU state and stores the FMU state in the given address of the reference FMUstate, the pointer to this copy.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
FMUstate::fmi3FMUstate: Argument FMUstate is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.
serialzedState::AbstractArray{fmi3Byte}: Argument serializedState contains the copy of the serialized data referenced by the pointer FMUstate.
size::Ref{Csize_t}: Argument size is an object that safely references a value of type Csize_t and defines the size of the byte vector in which the FMUstate can be stored.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.4. Getting and Setting the Complete FMU State

See also fmi3DeSerializeFMUState!.

FMICore.fmi3UpdateDiscreteStates — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.5. State: Event Mode

This function is called to signal a converged solution at the current super-dense time instant. fmi3UpdateDiscreteStates must be called at least once per super-dense time instant.

fmi3UpdateDiscreteStates(c::FMU3Instance, discreteStatesNeedUpdate::Ref{fmi3Boolean}, terminateSimulation::Ref{fmi3Boolean}, 
                                nominalsOfContinuousStatesChanged::Ref{fmi3Boolean}, valuesOfContinuousStatesChanged::Ref{fmi3Boolean},
                                nextEventTimeDefined::Ref{fmi3Boolean}, nextEventTime::Ref{fmi3Float64})

This function is called to signal a converged solution at the current super-dense time instant. fmi3UpdateDiscreteStates must be called at least once per super-dense time instant.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
discreteStatesNeedUpdate::Ref{fmi3Boolean}:
terminateSimulation::Ref{fmi3Boolean}:
nominalsOfContinuousStatesChanged::Ref{fmi3Boolean}:
valuesOfContinuousStatesChanged::Ref{fmi3Boolean}:
nextEventTimeDefined::Ref{fmi3Boolean}:
nextEventTime::Ref{fmi3Float64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.5. State: Event Mode

fmi3UpdateDiscreteStates(c::FMU3Instance)

This function is called to signal a converged solution at the current super-dense time instant. fmi3UpdateDiscreteStates must be called at least once per super-dense time instant. Results are returned, use fmi3UpdateDiscreteStates! for the inplace variant.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

discreteStatesNeedUpdate
terminateSimulation
nominalsOfContinuousStatesChanged
valuesOfContinuousStatesChanged
nextEventTimeDefined
nextEventTime

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.3.5. State: Event Mode

FMICore.fmi3EvaluateDiscreteStates — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

This function is called to trigger the evaluation of fdisc to compute the current values of discrete states from previous values. The FMU signals the support of fmi3EvaluateDiscreteStates via the capability flag providesEvaluateDiscreteStates.

fmi3EvaluateDiscreteStates(c::FMU3Instance)

This function is called to trigger the evaluation of fdisc to compute the current values of discrete states from previous values. The FMU signals the support of fmi3EvaluateDiscreteStates via the capability flag providesEvaluateDiscreteStates.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.3.3. State: Initialization Mode

See also fmi3EvaluateDiscreteStates.

FMIImport.fmi3GetNominalsOfContinuousStates — Function

fmi3GetNominalsOfContinuousStates(c::FMU3Instance)

Return the nominal values of the continuous states.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

x::Array{fmi3Float64}: Returns an array of fmi3Float64 values representing the new nominals of continuous state vector x.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.3.3. State: Initialization Mode

See also fmi3GetNominalsOfContinuousStates.

Getting Partial Dervatives

It is optionally possible to provide evaluation of partial derivatives for an FMU. For Model Exchange, this means computing the partial derivatives at a particular time instant. For Co-Simulation, this means to compute the partial derivatives at a particular communication point. One function is provided to compute directional derivatives. This function can be used to construct the desired partial derivative matrices.

FMIImport.fmi3GetDirectionalDerivative — Function

fmi3GetDirectionalDerivative(c::FMU3Instance,
    unknowns::AbstractArray{fmi3ValueReference},
    knowns::AbstractArray{fmi3ValueReference},
    seed::AbstractArray{fmi3Float64})

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the directional derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
- Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.

Returns

sensitivity::Array{fmi3Float64}: Return sensitivity contains the directional derivative vector values.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetDirectionalDerivative.

FMICore.fmi3GetDirectionalDerivative! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

This function computes the directional derivatives v{sensitivity} = J ⋅ v{seed} of an FMU.

unknowns - contains value references to the unknowns.

nUnknowns - contains the length of argument unknowns.

knowns - contains value references of the knowns.

nKnowns - contains the length of argument knowns.

seed - contains the components of the seed vector.

nSeed - contains the length of seed.

sensitivity - contains the components of the sensitivity vector.

nSensitivity - contains the length of sensitivity.

This function can only be called if the 'ProvidesDirectionalDerivatives' tag in the ModelDescription is set.

fmi3GetDirectionalDerivative!(c::FMU3Instance,
                                   unknowns::AbstractArray{fmi3ValueReference},
                                   nUnknowns::Csize_t,
                                   knowns::AbstractArray{fmi3ValueReference},
                                   nKnowns::Csize_t,
                                   seed::AbstractArray{fmi3Float64},
                                   nSeed::Csize_t,
                                   sensitivity::AbstractArray{fmi3Float64},
                                   nSensitivity::Csize_t)

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the directional derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
nUnknowns::Csize_t:
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
nKnowns::Csize_t:
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.
nKnowns::Csize_t:
sensitivity::AbstractArray{fmi3Float64}: Stores the directional derivative vector values.
nKnowns::Csize_t:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetDirectionalDerivative.

fmi3GetDirectionalDerivative!(c::FMU3Instance,
    unknowns::AbstractArray{fmi3ValueReference},
    knowns::AbstractArray{fmi3ValueReference},
    sensitivity::AbstractArray{fmi3Float64},
    seed::AbstractArray{fmi3Float64})

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the directional derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
- Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
sensitivity::AbstractArray{fmi3Float64}: Stores the directional derivative vector values.
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetDirectionalDerivative!.

FMIImport.fmi3GetContinuousStateDerivatives — Function

fmi3GetContinuousStateDerivatives(c::FMU3Instance)

Compute state derivatives at the current time instant and for the current states.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.

Returns

derivatives::Array{fmi3Float64}: Returns an array of fmi3Float64 values representing the derivatives for the current states. The ordering of the elements of the derivatives vector is identical to the ordering of the state

vector.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 3.2.1. State: Continuous-Time Mode

See also fmi3GetContinuousStateDerivatives.

FMICore.fmi3GetContinuousStateDerivatives! — Function

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

Compute first-oder state derivatives at the current time instant and for the current states.

fmi3GetContinuousStateDerivatives!(c::FMU3Instance,
                        derivatives::AbstractArray{fmi3Float64},
                        nx::Csize_t)

Compute state derivatives at the current time instant and for the current states.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
derivatives::AbstractArray{fmi3Float64}: Argument derivatives contains values of type fmi3Float64 which is a alias type for Real data type.derivatives is the AbstractArray which contains the Real values of the vector that represent the derivatives. The ordering of the elements of the derivatives vector is identical to the ordering of the state vector.
nx::Csize_t: Argument nx defines the length of vector derivatives and is provided for checking purposes

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 3.2.1. State: Continuous-Time Mode

See also fmi3GetContinuousStateDerivatives!.

fmi3GetContinuousStateDerivatives!(c::FMU3Instance, derivatives::Array{fmi3Float64})

Compute state derivatives at the current time instant and for the current states.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
derivatives::AbstractArray{fmi3Float64}: Argument derivatives contains values of type fmi3Float64 which is a alias type for Real data type.derivatives is the AbstractArray which contains the Real values of the vector that represent the derivatives. The ordering of the elements of the derivatives vector is identical to the ordering of the state vector.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 3.2.1. State: Continuous-Time Mode

See also fmi3GetContinuousStateDerivatives!.

FMIImport.fmi3GetAdjointDerivative — Function

fmi3GetAdjointDerivative(c::FMU3Instance,
    unknowns::AbstractArray{fmi3ValueReference},
    knowns::AbstractArray{fmi3ValueReference},
    seed::AbstractArray{fmi3Float64})

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the adjoint derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
- Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.

Returns

sensitivity::Array{fmi3Float64}: Return sensitivity contains the directional derivative vector values.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetAdjointDerivative.

FMICore.fmi3GetAdjointDerivative! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

This function computes the adjoint derivatives v^T{sensitivity}= v^T{seed} ⋅ J of an FMU.

unknowns - contains value references to the unknowns.

nUnknowns - contains the length of argument unknowns.

knowns - contains value references of the knowns.

nKnowns - contains the length of argument knowns.

seed - contains the components of the seed vector.

nSeed - contains the length of seed.

sensitivity - contains the components of the sensitivity vector.

nSensitivity - contains the length of sensitivity.

This function can only be called if the 'ProvidesAdjointDerivatives' tag in the ModelDescription is set.

fmi3GetAdjointDerivative!(c::FMU3Instance,
            unknowns::AbstractArray{fmi3ValueReference},
            nUnknowns::Csize_t,
            knowns::AbstractArray{fmi3ValueReference},
            nKnowns::Csize_t,
            seed::AbstractArray{fmi3Float64},
            nSeed::Csize_t,
            sensitivity::AbstractArray{fmi3Float64},
            nSensitivity::Csize_t)

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the adjoint derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
nUnknowns::Csize_t:
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
nKnowns::Csize_t:
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.
nKnowns::Csize_t:
sensitivity::AbstractArray{fmi3Float64}: Stores the adjoint derivative vector values.
nKnowns::Csize_t:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetAdjointDerivative!.

fmi3GetAdjointDerivative!(c::FMU3Instance,
    unknowns::AbstractArray{fmi3ValueReference},
    knowns::AbstractArray{fmi3ValueReference},
    sensitivity::AbstractArray{fmi3Float64},
    seed::AbstractArray{fmi3Float64})

Wrapper Function call to compute the partial derivative with respect to the variables unknowns.

Computes the adjoint derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns. The precise definitions are given in the mathematical descriptions of Model Exchange (section 3) and Co-Simulation (section 4). In every Mode, the general form of the FMU equations are: unknowns = 𝐡(knowns, rest)

unknowns: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknown> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Output> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><ContinuousStateDerivative>).
- Event Mode (ModelExchange/CoSimulation): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Output> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Output> with type Real and variability = continuous or discrete. If <ModelStructure><ContinuousStateDerivative> is present, also the variables listed here as state derivatives.
knowns: Real input variables of function h that changes its value in the actual Mode.
rest: Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δunknowns = (δh / δknowns) Δknowns

Arguments

c::FMU3Instance Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
unknowns::AbstracArray{fmi3ValueReference}: Argument unknowns contains values of typefmi3ValueReference which are identifiers of a variable value of the model. unknowns can be equated with unknowns(variable described above).
knowns::AbstractArray{fmi3ValueReference}: Argument knowns contains values of type fmi3ValueReference which are identifiers of a variable value of the model.knowns can be equated with knowns(variable described above).
sensitivity::AbstractArray{fmi3Float64}: Stores the directional derivative vector values.
seed::AbstractArray{fmi3Float64}:The vector values Compute the partial derivative with respect to the given entries in vector knowns with the matching evaluate of sensitivity.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.11. Getting Partial Derivatives

See also fmi3GetAdjointDerivative!.

FMIImport.fmi3GetOutputDerivatives — Function

fmi3GetOutputDerivatives!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nValueReferences::Csizet, order::AbstractArray{fmi3Int32}, values::AbstractArray{fmi3Float64}, nValues::Csizet)

Retrieves the n-th derivative of output values.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::Array{fmi3ValueReference}: Argument vr is an array of nValueReferences value handels called "ValueReference" that t define the variables whose derivatives shall be set.
order::Array{fmi3Int32}: Argument order is an array of fmi3Int32 values witch specifys the corresponding order of derivative of the real input variable.

Returns

value::AbstactArray{fmi3Float64}: Return value is an array which represents a vector with the values of the derivatives.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.12. Getting Derivatives of Continuous Outputs

See also fmi3GetOutputDerivatives.

FMICore.fmi3GetOutputDerivatives! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.12. Getting Derivatives of Continuous Outputs

Retrieves the n-th derivative of output values.

valueReferences - is a vector of value references that define the variables whose derivatives shall be retrieved. If multiple derivatives of a variable shall be retrieved, list the value reference multiple times.

nValueReferences - is the dimension of the arguments valueReferences and orders.

orders - contains the orders of the respective derivative (1 means the first derivative, 2 means the second derivative, …, 0 is not allowed). If multiple derivatives of a variable shall be retrieved, provide a list of them in the orders array, corresponding to a multiply occurring value reference in the valueReferences array. The highest order of derivatives retrievable can be determined by the 'maxOutputDerivativeOrder' tag in the ModelDescription.

values - is a vector with the values of the derivatives. The order of the values elements is derived from a twofold serialization: the outer level corresponds to the combination of a value reference (e.g., valueReferences[k]) and order (e.g., orders[k]), and the inner level to the serialization of variables as defined in Section 2.2.6.1. The inner level does not exist for scalar variables.

nValues - is the size of the argument values. nValues only equals nValueReferences if all corresponding output variables are scalar variables.

fmi3GetOutputDerivatives!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nValueReferences::Csize_t, order::AbstractArray{fmi3Int32}, values::AbstractArray{fmi3Float64}, nValues::Csize_t)

Retrieves the n-th derivative of output values.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::Array{fmi3ValueReference}: Argument vr is an array of nValueReferences value handels called "ValueReference" that t define the variables whose derivatives shall be set.
nValueReferences::Csize_t: Argument nValueReferences defines the size of vr.
order::Array{fmi3Int32}: Argument order is an array of fmi3Int32 values witch specifys the corresponding order of derivative of the real input variable.
values::Array{fmi3Float64}: Argument values is an array with the actual values of these variables.
nValues::Csize_t: Argument nValues defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.12. Getting Derivatives of Continuous Outputs

See also fmi3GetOutputDerivatives!.

fmi3SampleDirectionalDerivative fmi3SampleDirectionalDerivative! fmi3GetJacobian fmi3GetJacobian! fmi3GetFullJacobian fmi3GetFullJacobian!

TODO: Clockstuff

FMICore.fmi3GetIntervalDecimal! — Function

fmi3GetIntervalDecimal!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, intervals::AbstractArray{fmi3Float64}, qualifiers::fmi3IntervalQualifier)

fmi3GetIntervalDecimal retrieves the interval until the next clock tick.

For input Clocks it is allowed to call this function to query the next activation interval. For changing aperiodic Clock, this function must be called in every Event Mode where this clock was activated. For countdown aperiodic Clock, this function must be called in every Event Mode. Clock intervals are computed in fmi3UpdateDiscreteStates (at the latest), therefore, this function should be called after fmi3UpdateDiscreteStates. For information about fmi3IntervalQualifiers, call ?fmi3IntervalQualifier

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
intervals::AbstractArray{fmi3Float64}:
qualifiers::fmi3IntervalQualifier:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3GetIntervalDecimal!.

FMICore.fmi3SetIntervalDecimal — Function

fmi3SetIntervalDecimal(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, intervals::AbstractArray{fmi3Float64})

Sets the interval until the next clock tick

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
intervals::AbstractArray{fmi3Float64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3SetIntervalDecimal.

FMICore.fmi3GetIntervalFraction! — Function

fmi3GetIntervalFraction!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, intervalCounters::AbstractArray{fmi3UInt64}, resolutions::AbstractArray{fmi3UInt64}, qualifiers::fmi3IntervalQualifier)

fmi3GetIntervalFraction retrieves the interval until the next clock tick.

For input Clocks it is allowed to call this function to query the next activation interval. For changing aperiodic Clock, this function must be called in every Event Mode where this clock was activated. For countdown aperiodic Clock, this function must be called in every Event Mode. Clock intervals are computed in fmi3UpdateDiscreteStates (at the latest), therefore, this function should be called after fmi3UpdateDiscreteStates. For information about fmi3IntervalQualifiers, call ?fmi3IntervalQualifier

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
intervalCounters::AbstractArray{fmi3UInt64}:
resolutions::AbstractArray{fmi3UInt64}:
qualifiers::fmi3IntervalQualifier:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3GetIntervalFraction!.

FMICore.fmi3SetIntervalFraction — Function

fmi3SetIntervalFraction(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, intervalCounters::AbstractArray{fmi3UInt64}, resolutions::AbstractArray{fmi3UInt64})

Sets the interval until the next clock tick. Only allowed if the attribute 'supportsFraction' is set.

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
intervalCounters::AbstractArray{fmi3UInt64}:
resolutions::AbstractArray{fmi3UInt64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3SetIntervalFraction.

FMICore.fmi3GetShiftDecimal! — Function

fmi3GetShiftDecimal!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, shifts::AbstractArray{fmi3Float64})

fmi3GetShiftDecimal retrieves the delay to the first Clock tick from the FMU.

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
shifts::AbstractArray{fmi3Float64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3GetShiftDecimal!.

FMICore.fmi3GetShiftFraction! — Function

fmi3GetShiftFraction!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, shiftCounters::AbstractArray{fmi3UInt64}, resolutions::AbstractArray{fmi3UInt64})

fmi3GetShiftFraction retrieves the delay to the first Clock tick from the FMU.

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
shiftCounters::AbstractArray{fmi3UInt64}:
resolutions::AbstractArray{fmi3UInt64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.9. Clocks

See also fmi3GetShiftFraction!.

FMIImport.fmi3GetClock — Function

fmi3GetClock(c::FMU3Instance, vr::fmi3ValueReferenceFormat)

Get the values of an array of fmi3Clock variables.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi3Clock}: returns values of an array of fmi3Clock variables with the dimension of fmi3ValueReferenceFormat length.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetClock.

FMICore.fmi3GetClock! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3GetClock!(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Clock}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
value::AbstractArray{fmi3Clock}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetClock!.

fmi3GetClock!(c::FMU3Instance, vr::fmi3ValueReferenceFormat, values::AbstractArray{fmi3Clock})

Writes the clock values of an array of variables in the given field

fmi3GetClock! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::AbstractArray{fmi3Clock}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3GetClock!.

FMICore.fmi3SetClock — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Functions to get and set values of variables idetified by their valueReference.

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

fmi3SetClock(c::FMU3Instance, vr::AbstractArray{fmi3ValueReference}, nvr::Csize_t, value::AbstractArray{fmi3Clock}, nvalue::Csize_t)

Functions to get and set values of variables idetified by their valueReference.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::AbstractArray{fmi3ValueReference}: Argument vr is an AbstractArray of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
value::AbstractArray{fmi3Clock}: Argument values is an AbstractArray with the actual values of these variables.
nvalue::Csize_t: Argument nvalue defines the size of values.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetClock.

fmi3SetClock(c::FMU3Instance, vr::fmi3ValueReferenceFormat, valueSizes::Union{AbstractArray{Csize_t}, Csize_t}, values::Union{AbstractArray{fmi3Clock}, fmi3Clock})

Set the values of an array of clock variables

Arguments

c::FMU3Instance: Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi3ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi3ValueReference, Array{fmi3ValueReference,1}, Int64, Array{Int64,1}, Symbol}

values::Union{AbstractArray{fmi3Clock}, fmi3Clock}: Argument values is an AbstractArray with the actual values of these variables.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.6.2. Getting and Setting Variable Values

See also fmi3SetClock.

FMICore.fmi3ActivateModelPartition — Function

fmi3ActivateModelPartition(c::FMU3Instance, vr::fmi3ValueReference, activationTime::AbstractArray{fmi3Float64})

During Clock Activation Mode (see 5.2.2.) after fmi3ActivateModelPartition has been called for a calculated, tunable or changing Clock the FMU provides the information on when the Clock will tick again, i.e. when the corresponding model partition has to be scheduled the next time.

Each fmi3ActivateModelPartition call is associated with the computation of an exposed model partition of the FMU and therefore to an input Clock.

TODO argmuents

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReference: Argument vr is the value handel called "ValueReference" that define the variable that shall be inquired.
activationTime::AbstractArray{fmi3Float64}:

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 5.2.2. State: Clock Activation Mode

See also fmi3ActivateModelPartition.

fmi3CallbackClockUpdate

Conversion functions

FMIBase.stringToType — Function

stringToType(s::AbstractString)

Convert s ("coSimulation", "modelExchange", "scheduledExecution") to the corresponding fmi3Type.

FMIBase.typeToString — Function

typeToString(c::fmi3Type)

Convert fmi3Type c to the corresponding String ("coSimulation", "modelExchange", "scheduledExecution").

FMIBase.stringToVariableNamingConvention — Function

stringToVariableNamingConvention(s::AbstractString)

Convert s ("flat", "structured") to the corresponding fmi3VariableNamingConvention.

FMIBase.variableNamingConventionToString — Function

variableNamingConventionToString(c::fmi3VariableNamingConvention)

Convert fmi3VariableNamingConvention c to the corresponding String ("flat", "structured").

FMIBase.intervalQualifierToString — Function

intervalQualifierToString(c::fmi3IntervalQualifier)

Convert fmi3IntervalQualifier c to the corresponding String ("intervalNotYetKnown", "intervalUnchanged", "intervalChanged").

fmi3StringToCausality fmi3StatusToString fmi3StringToInitial

External/Additional functions

FMIImport.fmi3GetNumberOfVariableDependencies — Function

fmi3GetNumberOfVariableDependencies(c::FMU3Instance, vr::fmi3ValueReference, nvr::Ref{Csize_t})

The number of dependencies of a given variable, which may change if structural parameters are changed, can be retrieved by calling fmi3GetNumberOfVariableDependencies.

This information can only be retrieved if the 'providesPerElementDependencies' tag in the ModelDescription is set.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::Union{fmi3ValueReference, String}: Argument vr is the value handel called "ValueReference" that define the variable that shall be inquired.

Returns

size::Integer: Return size is the number of variable dependencies for the given variable

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.10. Dependencies of Variables

See also fmi3GetNumberOfVariableDependencies.

FMICore.fmi3GetNumberOfVariableDependencies! — Function

fmi3GetNumberOfVariableDependencies!(c::FMU3Instance, vr::fmi3ValueReference, nvr::Ref{Csize_t})

The number of dependencies of a given variable, which may change if structural parameters are changed, can be retrieved by calling fmi3GetNumberOfVariableDependencies.

This information can only be retrieved if the 'providesPerElementDependencies' tag in the ModelDescription is set.

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReference: Argument vr is the value handel called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.10. Dependencies of Variables

See also fmi3GetNumberOfVariableDependencies!.

FMIImport.fmi3GetVariableDependencies — Function

fmi3GetVariableDependencies(c::FMU3Instance, vr::Union{fmi3ValueReference, String})

The actual dependencies (of type dependenciesKind) can be retrieved by calling the function fmi3GetVariableDependencies:

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::Union{fmi3ValueReference, String}: Argument vr is the value handel called "ValueReference" that define the variable that shall be inquired.

Returns

elementIndicesOfDependent::AbstractArray{Csize_t}: must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the dependent variable that dependency information is provided for. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)
independents::AbstractArray{fmi3ValueReference}: must point to a buffer of fmi3ValueReference values of size nDependencies allocated by the calling environment. It is filled in by this function with the value reference of the independent variable that this dependency entry is dependent upon.
elementIndicesIndependents::AbstractArray{Csize_t}: must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the independent variable that this dependency entry is dependent upon. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)
dependencyKinds::AbstractArray{fmi3DependencyKind}: must point to a buffer of dependenciesKind values of size nDependencies allocated by the calling environment. It is filled in by this function with the enumeration value describing the dependency of this dependency entry.

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.10. Dependencies of Variables

See also fmi3GetVariableDependencies!.

FMICore.fmi3GetVariableDependencies! — Function

fmi3GetVariableDependencies!(c::FMU3Instance, vr::fmi3ValueReference, elementIndiceOfDependents::AbstractArray{Csize_t}, independents::AbstractArray{fmi3ValueReference},  
    elementIndiceOfInpendents::AbstractArray{Csize_t}, dependencyKind::AbstractArray{fmi3DependencyKind}, ndependencies::Csize_t)

The actual dependencies (of type dependenciesKind) can be retrieved by calling the function fmi3GetVariableDependencies:

Arguments

c::FMU3Instance: Argument c is a Mutable struct represents an instantiated instance of an FMU in the FMI 3.0 Standard.
vr::fmi3ValueReference: Argument vr is the value handel called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
elementIndiceOfDependents::AbstractArray{Csize_t}: must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the dependent variable that dependency information is provided for. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)
independents::AbstractArray{fmi3ValueReference}: must point to a buffer of fmi3ValueReference values of size nDependencies allocated by the calling environment. It is filled in by this function with the value reference of the independent variable that this dependency entry is dependent upon.
elementIndiceOfInpendents::AbstractArray{Csize_t}: must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the independent variable that this dependency entry is dependent upon. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)
dependencyKind::AbstractArray{fmi3DependencyKind}: must point to a buffer of dependenciesKind values of size nDependencies allocated by the calling environment. It is filled in by this function with the enumeration value describing the dependency of this dependency entry.
ndependencies::Csize_t: specifies the number of dependencies that the calling environment allocated space for in the result buffers, and should correspond to value obtained by calling fmi3GetNumberOfVariableDependencies.

Returns

status::fmi3Status: Return status is an enumeration of type fmi3Status and indicates the success of the function call.

More detailed:

fmi3OK: all well
fmi3Warning: things are not quite right, but the computation can continue
fmi3Discard: if the slave computed successfully only a subinterval of the communication step
fmi3Error: the communication step could not be carried out at all
fmi3Fatal: if an error occurred which corrupted the FMU irreparably

Source

FMISpec3.0 Link: https://fmi-standard.org/
FMISpec3.0: 2.2.3 Platform Dependent Definitions
FMISpec3.0: 2.2.4 Status Returned by Functions
FMISpec3.0: 2.2.10. Dependencies of Variables

See also fmi3GetVariableDependencies!.