FmuAspect Class |
Namespace: Emulate3D.FMI
public sealed class FmuAspect : VisualAspect, IDisposable
The FmuAspect type exposes the following members.
| Name | Description | |
|---|---|---|
| AllowedCausality |
Allowed variable causality.
| |
| AllowedInitial |
Allowed variable initial.
| |
| AllowedLogCategories |
Allowed log categories. Log categories are only populated when the FMU is loaded.
| |
| AllowedLogStatus |
Allowed log status.
| |
| AllowedVariability |
Allowed variable variability.
| |
| AllowsVariableStepSize |
True if the FMU allows variable step sizes.
| |
| AspectManagedBy |
The Aspect that this is managed by.
(Inherited from AspectComponentBase.) | |
| BindingNameStore |
Manages binding names for aspect bindable items.
(Inherited from AspectComponentBase.) | |
| CurrentStep |
The current communication step size in milliseconds.
Updated after the step size has been calculated, but before the step is executed.
-1 indicates no current step size.
| |
| DiscardAction |
The action to take when an API method returns a Discard status.
The action is only taken when the API is called by the simulation, not as a result of scripting.
| |
| EnableLogging |
Set to enable FMU logging.
| |
| ErrorAction |
The action to take when an API method returns an Error status.
The action is only taken when the API is called by the simulation, not as a result of scripting.
| |
| FatalAction |
The action to take when an API method returns a Fatal status.
The action is only taken when the API is called by the simulation, not as a result of scripting.
| |
| Fmu |
Loaded FMU.
Guaranteed non-null and loaded during model runs.
| |
| Id | (Inherited from SerializableObject.) | |
| IndividualIO |
If true, IO functions are individually called for each variable.
If false, variables of the same type are batched and IO functions are only called once per type.
| |
| Instance |
FMU instance.
Guaranteed non-null during model runs.
| |
| InstanceName |
FMU instance name.
| |
| IsCollapsed |
Collapse or expand the aspect in the Aspect Viewer.
(Inherited from AspectComponentBase.) | |
| IsEnabled |
The value for whether the aspect is enabled.
(Inherited from AspectComponentBase.) | |
| IsInstantiated |
FMU instance is instantiated.
| |
| IsLoaded |
FMU is loaded.
| |
| IsReadOnly |
When true, disable editing in the Aspect Viewer
(Inherited from AspectComponentBase.) | |
| MaxStep |
If the FMU allows variable step sizes,
the maximum communication step size in milliseconds.
| |
| MinStep |
If the FMU allows variable step sizes,
the minimum communication step size in milliseconds.
| |
| ModelDescription |
FMU model description.
| |
| OKAction |
The action to take when an API method returns an OK status.
The action is only taken when the API is called by the simulation, not as a result of scripting.
| |
| Platform |
FMU instance platform.
| |
| PreferredStep |
If the FMU allows variable step sizes,
the preferred communication step size in milliseconds.
-1 indicates no preferred step size.
| |
| ReceiveTimeout | ||
| StopTimeAction |
Defines what action to take when the simulation reaches a pre-defined stop-time.
| |
| Visual | (Inherited from VisualAspect.) | |
| WarningAction |
The action to take when an API method returns an Warning status.
The action is only taken when the API is called by the simulation, not as a result of scripting.
|
| Name | Description | |
|---|---|---|
| BindingName |
Retrieves or generates a binding name for an aspect property.
(Inherited from AspectComponentBase.) | |
| CreateInstance |
Create FMU instance.
| |
| CreateManagedAspectT |
Create a managed aspect of the desired type in this aspect's container. The managed aspect will be owned by the declared aspect.
(Inherited from AspectComponentBase.) | |
| DestroyInstance |
Destroy FMU instance.
| |
| Dispose | Releases all resources used by the FmuAspect | |
| FindAspectT |
Find an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.) | |
| FindCreateAspectT |
Find or, if one isn't found, create an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.) | |
| FindCreateManagedAspectT |
Find or, if one isn't found, create a managed aspect of the desired type in this aspect's container. The managed aspect will be owned by the declared aspect.
(Inherited from AspectComponentBase.) | |
| RaisePropertiesChanged |
Raise an PropertyChanged event for each value.
(Inherited from BindableBase.) | |
| RaisePropertyChanged(PropertyChangedEventArgs) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) | |
| RaisePropertyChanged(String) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) | |
| ReleaseBindingName |
Releases the generated binding name for an aspect property.
(Inherited from AspectComponentBase.) | |
| RemoveAspect(Object) |
Remove the desired aspect from this aspect's container.
(Inherited from AspectComponentBase.) | |
| RemoveAspectT |
Remove the aspect of the desired type from this aspect's container.
(Inherited from AspectComponentBase.) | |
| RemoveManagedAspects |
Remove all aspects that are being managed by this aspect..
(Inherited from AspectComponentBase.) | |
| SerializableDependency(SerializableObject) | Obsolete.
Whether the specified object depends on the serializable object.
(Inherited from AspectComponentBase.) | |
| SerializableDependency(Visual) | Obsolete.
Whether the specified visual depends on the serializable object.
(Inherited from AspectComponentBase.) | |
| ToString | (Inherited from AspectComponentBase.) | |
| UnloadFmu |
Unload FMU for this aspect.
If this aspect is the last one to unload, then the FMU is unloaded from the document fully.
|
| Name | Description | |
|---|---|---|
| IsEnabledChanged |
Occurs when the value of IsEnabled changes.
(Inherited from AspectComponentBase.) | |
| OnFmuLoaded |
Raised when Fmu is loaded.
| |
| OnFmuUnloaded |
Raised when Fmu is unloaded and disposed.
| |
| OnInstanceCreated |
Raised when Instance is created.
| |
| OnInstanceDestroyed |
Raised when Instance is destroyed.
| |
| OnNameChanged |
Occurs when the Name of an aspect changes.
(Inherited from AspectComponentBase.) |