Enum Fmi3Error 

pub enum Fmi3Error {
    Discard,
    Error,
    Fatal,
}

Available on crate feature fmi3 only.

Variants

Discard

The call was not successful and the FMU is in the same state as before the call. The output argument values are undefined, but the computation may continue. Function logMessage should be called by the FMU with further information before returning this status, respecting the current logging settings. Advanced importers may try alternative approaches to continue the simulation by calling the function with different arguments or calling another function - except in FMI for Scheduled Execution where repeating failed function calls is not allowed. Otherwise the simulation algorithm must treat this return code like Fmi3Error::Error and must terminate the simulation.

[Examples for usage of Discard are handling of min/max violation, or signal numerical problems during model evaluation forcing smaller step sizes.]

Error

The call failed. The output argument values are undefined and the simulation must not be continued. Function logMessage should be called by the FMU with further information before returning this status, respecting the current logging settings. If a function returns Fmi3Error::Error, it is possible to restore a previously retrieved FMU state by calling set_fmu_state. Otherwise Reset must be called (or the instance freed).

When detecting illegal arguments or a function call not allowed in the current state according to the respective state machine, the FMU must return Fmi3Error::Error. Other instances of this FMU are not affected by the error.

Fatal

Trait Implementations

impl Debug for Fmi3Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Fmi3Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Fmi3Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Fmi3Error> for Error

fn from(source: Fmi3Error) -> Self

Converts to this type from the input type.

impl From<Fmi3Error> for Fmi3Status

fn from(err: Fmi3Error) -> Self

Converts to this type from the input type.

impl PartialEq for Fmi3Error

fn eq(&self, other: &Fmi3Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Fmi3Error