Skip to content

Gateway

Gateway Model

When implemented, a Gateway Model makes it possible for a foreign Simulation Environment to connect with a Dynamic Simulation Environment. The two simulation environments can then exchange signals and maintain synchronisation.

Component Diagram

Example

{{< readfile file="../examples/gateway.c" code="true" lang="c" >}}

Typedefs

ModelGatewayDesc

typedef struct ModelGatewayDesc {
    int* sim;
    int* mi;
    int* sv;
    const char** argv;
    char* name_arg;
    double clock_epsilon;
    uint64_t[4] __reserved__;
}

Functions

model_gw_exit

Terminates the Gateway Model and releases all objects referenced by the ModelGatewayDesc object. The object itself is not affected and should be released by the caller (if necessary).

Parameters

gw (ModelGatewayDesc*)
A gateway descriptor object, holds references to various ModelC objects.

Returns

0
Success.
+ve
Failure, inspect errno for the failing condition.

model_gw_setup

Parameters

gw (ModelGatewayDesc*)
A gateway descriptor object, holds references to various ModelC objects.
name (const char*)
Name of the gateway model. Used when parsing the provided YAML files to select the relevant configuration items (i.e. Model and SignalGroup schemas).
yaml_files (const char*)
A list of YAML files where the relevant gateway configuration objects should be found.
log_level (int)
The log level to apply to the gateway model. Common values include; LOG_NOTICE (default), LOG_INFO, LOG_QUIET (only errors) or LOG_DEBUG. Set to a negative number to use the default log level.
step_size (double)
Step size for interactions with the Simbus.
end_time (double)
End time for the simulation (acts as guard against "forever" simulations).

Returns

0
Success.
+ve
Failure, inspect errno for the failing condition.

model_gw_sync

Parameters

gw (ModelGatewayDesc*)
A gateway descriptor object, holds references to various ModelC objects.
model_time (double)
The current simulation time of the gateway model for which the Gateway API should synchronise with.

Returns

0
Success.
E_GATEWAYBEHIND
The specified model_time is behind the simulation time. The time should be advanced by the caller and then retry this call until the condition clears.
+ve
Failure, inspect errno for the failing condition.