PropertyPackageCheckSinglePhasePropSpec Method

Request Example View Source

Parameters

property  String

The identifier of the property to check. To be valid this must be one of the supported single-phase properties or derivatives (as given by the GetSinglePhasePropList method).

phaseLabel  String

The Phase label for the calculation check. This must be one of the labels returned by the GetPhaseList method on the ICapeThermoPhases interface.

Return Value

Boolean
Set to True if the combination of property and phaseLabel is supported or False if not supported.

Implements

ICapeThermoPropertyRoutine.CheckSinglePhasePropSpec(String, String)

The result of the check should only depend on the capabilities and configuration (Compounds and Phases supported) of the component that implements the ICapeThermoPropertyRoutine interface (e.g. a Property Package). It should not depend on whether a Material Object has been set nor on the state (temperature, pressure, composition etc.), or configuration of a Material Object that might be set. It is expected that the PME, or other client, will use this method to check whether the properties it requires are supported by the Property Package when the package is imported. If any essential properties are not available, the import process should be aborted. If either the property or the phaseLabel arguments are not recognised by the component that implements the ICapeThermoPropertyRoutine interface this method should return False.