uint64_state

Description

Interface to transfer a state representable in an uint64 from one device to another. Examples of what the state might represent includes:

a fixed-point value representing the level of an analog signal

an integer representing a counter

an integer representing an enum value

The initiator should call set when the value changes, and after a new target is connected. The object implementing uint64_state should accept multiple calls to set with the same level, and may let this trigger side-effects. Therefore, any repeated calls must be deterministic; in particular, set must not be called while restoring a checkpoint.

A device implementing this interface may choose to only accept a certain set of integer values; it is then an error to send any other values to the set method. A user must therefore be careful to read the documentation of both the source and destination object to make sure they are compatible.

No interface call needs to be done after disconnecting a target; the target needs to be notified of this through some other channel (typically via a connector)

Note: The uint64_state interface should be used instead of the deprecated multi_level_signal interface when writing new models.

SIM_INTERFACE(uint64_state) {
        void (*set)(conf_object_t *NOTNULL obj, uint64 level);
};
#define UINT64_STATE_INTERFACE "uint64_state"

Execution Context

Cell Context for all methods.