FmiVariable

class mlfmu.types.fmu_component.FmiVariable(name: str = '', variable_reference: int = 0, type: FmiVariableType = FmiVariableType.REAL, start_value: bool | str | int | float = 0, causality: FmiCausality = FmiCausality.INPUT, description: str = '', variability: FmiVariability = FmiVariability.CONTINUOUS)

Bases: object

Data class representing a variable in an FMU component.

__init__(name: str = '', variable_reference: int = 0, type: FmiVariableType = FmiVariableType.REAL, start_value: bool | str | int | float = 0, causality: FmiCausality = FmiCausality.INPUT, description: str = '', variability: FmiVariability = FmiVariability.CONTINUOUS) → None

Methods

__init__([name, variable_reference, type, ...])

Attributes

causality	The causality of the variable.
description	The description of the variable.
name	The name of the variable.
start_value	The initial value of the variable.
type	The type of the variable.
variability	The variability of the variable.
variable_reference	The reference ID of the variable.

causality: FmiCausality = 'input'

The causality of the variable.

description: str = ''

The description of the variable.

name: str = ''

The name of the variable.

start_value: bool | str | int | float = 0

The initial value of the variable.

type: FmiVariableType = 'real'

The type of the variable.

variability: FmiVariability = 'continuous'

The variability of the variable.

variable_reference: int = 0

The reference ID of the variable.