Click or drag to resize

FmuAspect Class

Allows a visual to represent an FMU instance.
Inheritance Hierarchy
System.DynamicDynamicObject
  NotifyPropertyChangedBase
    SimpleCustomTypeDescriptor
      GlobalizedProperties
        Demo3D.CommonBindableBase
          Demo3D.VisualsSerializableObject
            Demo3D.VisualsAspectComponentBase
              Demo3D.VisualsVisualAspect
                Emulate3D.FMIFmuAspect

Namespace:  Emulate3D.FMI
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 18.03.00
Syntax
C#
public sealed class FmuAspect : VisualAspect, 
	IDisposable

The FmuAspect type exposes the following members.

Constructors
  NameDescription
Public methodFmuAspect
Initializes a new instance of the FmuAspect class
Top
Properties
  NameDescription
Public propertyAllowedCausality
Allowed variable causality.
Public propertyAllowedInitial
Allowed variable initial.
Public propertyAllowedLogCategories
Allowed log categories. Log categories are only populated when the FMU is loaded.
Public propertyAllowedLogStatus
Allowed log status.
Public propertyAllowedVariability
Allowed variable variability.
Public propertyAllowsVariableStepSize
True if the FMU allows variable step sizes.
Public propertyAspectManagedBy
The Aspect that this is managed by.
(Inherited from AspectComponentBase.)
Public propertyBindingNameStore
Manages binding names for aspect bindable items.
(Inherited from AspectComponentBase.)
Public propertyCurrentStep
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.
Public propertyDiscardAction
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.
Public propertyEnableLogging
Set to enable FMU logging.
Public propertyErrorAction
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.
Public propertyFatalAction
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.
Public propertyFmu
Loaded FMU. Guaranteed non-null and loaded during model runs.
Public propertyId (Inherited from SerializableObject.)
Public propertyIndividualIO
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.
Public propertyInstance
FMU instance. Guaranteed non-null during model runs.
Public propertyInstanceName
FMU instance name.
Public propertyIsCollapsed
Collapse or expand the aspect in the Aspect Viewer.
(Inherited from AspectComponentBase.)
Public propertyIsEnabled
The value for whether the aspect is enabled.
(Inherited from AspectComponentBase.)
Public propertyIsInstantiated
FMU instance is instantiated.
Public propertyIsLoaded
FMU is loaded.
Public propertyIsReadOnly
When true, disable editing in the Aspect Viewer
(Inherited from AspectComponentBase.)
Public propertyMaxStep
If the FMU allows variable step sizes, the maximum communication step size in milliseconds.
Public propertyMinStep
If the FMU allows variable step sizes, the minimum communication step size in milliseconds.
Public propertyModelDescription
FMU model description.
Public propertyOKAction
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.
Public propertyPlatform
FMU instance platform.
Public propertyPreferredStep
If the FMU allows variable step sizes, the preferred communication step size in milliseconds. -1 indicates no preferred step size.
Public propertyStopTimeAction
Defines what action to take when the simulation reaches a pre-defined stop-time.
Public propertyVisual (Inherited from VisualAspect.)
Public propertyWarningAction
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.
Top
Methods
  NameDescription
Public methodBindingName
Retrieves or generates a binding name for an aspect property.
(Inherited from AspectComponentBase.)
Public methodCreateInstance
Create FMU instance.
Public methodCreateManagedAspectT
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.)
Public methodDestroyInstance
Destroy FMU instance.
Public methodDispose
Releases all resources used by the FmuAspect
Public methodFindAspectT
Find an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.)
Public methodFindCreateAspectT
Find or, if one isn't found, create an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.)
Public methodFindCreateManagedAspectT
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.)
Public methodRaisePropertiesChanged
Raise an PropertyChanged event for each value.
(Inherited from BindableBase.)
Public methodRaisePropertyChanged(PropertyChangedEventArgs)
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.)
Public methodRaisePropertyChanged(String)
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.)
Public methodReleaseBindingName
Releases the generated binding name for an aspect property.
(Inherited from AspectComponentBase.)
Public methodRemoveAspect(Object)
Remove the desired aspect from this aspect's container.
(Inherited from AspectComponentBase.)
Public methodRemoveAspectT
Remove the aspect of the desired type from this aspect's container.
(Inherited from AspectComponentBase.)
Public methodRemoveManagedAspects
Remove all aspects that are being managed by this aspect..
(Inherited from AspectComponentBase.)
Public methodSerializableDependency(SerializableObject) Obsolete.
Whether the specified object depends on the serializable object.
(Inherited from AspectComponentBase.)
Public methodSerializableDependency(Visual) Obsolete.
Whether the specified visual depends on the serializable object.
(Inherited from AspectComponentBase.)
Public methodToString (Inherited from AspectComponentBase.)
Public methodUnloadFmu
Unload FMU for this aspect. If this aspect is the last one to unload, then the FMU is unloaded from the document fully.
Top
Events
  NameDescription
Public eventIsEnabledChanged
Occurs when the value of IsEnabled changes.
(Inherited from AspectComponentBase.)
Public eventOnFmuLoaded
Raised when Fmu is loaded.
Public eventOnFmuUnloaded
Raised when Fmu is unloaded and disposed.
Public eventOnInstanceCreated
Raised when Instance is created.
Public eventOnInstanceDestroyed
Raised when Instance is destroyed.
Public eventOnNameChanged
Occurs when the Name of an aspect changes.
(Inherited from AspectComponentBase.)
Top
See Also