ICapeUtilitiessimulationContext Property

Sets the component's simulation context.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[DispIdAttribute(2)]
Object simulationContext { set; }

Property Value

Object
The reference to the PME’s simulation context class. For the PMC to use this class, this reference will have to be converted to each of the defined CO Simulation Context interfaces.

Remarks

Allows the PME to convey the PMC a reference to the former’s simulation context. The simulation context will be PME objects which will expose a given set of CO interfaces. Each of these interfaces will allow the PMC to call back the PME in order to benefit from its exposed services (such as creation of material templates, diagnostics or measurement unit conversion). If the PMC does not support accessing the simulation context, it is recommended to raise the ECapeNoImpl error.

Initially, this method was only present in the ICapeUnit interface. Since ICapeUtilities.SetSimulationContext is now available for any kind of PMC, ICapeUnit.SetSimulationContext is deprecated.

Exceptions

ECapeUnknownThe error to be raised when other error(s), specified for this operation, are not suitable.
ECapeFailedInitialisationECapeFailedInitialisation
ECapeInvalidArgumentTo be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument.
ECapeNoImplECapeNoImpl

See Also