CapeThermoMaterialWrapperCheckSinglePhasePropSpec Method

Checks whether it is possible to calculate a property with the CalcSinglePhaseProp method for a given Phase.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

private bool CheckSinglePhasePropSpec(
	string property,
	string phaseLabel
)

VBRequest Example

Private Function CheckSinglePhasePropSpec ( 
	property As String,
	phaseLabel As String
) As Boolean

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
A boolean set to True if the combination of property and phaseLabel is supported or False if not supported.

Remarks

The result of the check should only depend on the capabilities and configuration (Compounds and Phases present) of the component that implements the ICapeThermoPropertyRoutine interface (eg. 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.

Exceptions

ECapeNoImpl	The operation CheckSinglePhasePropSpec is “not” implemented even if this method can be called for reasons of compatibility with the CAPE-OPEN standards. That is to say that the operation exists, but it is not supported by the current implementation.
ECapeBadInvOrder	The necessary pre-requisite operation has not been called prior to the operation request. The ICapeThermoMaterial interface has not been passed via a SetMaterial call prior to calling this method.
ECapeFailedInitialisation	The pre-requisites for the property calculation are not valid. For example, if a prior call to the SetMaterial method of the ICapeThermoMaterialContext interface has failed to provide a valid Material Object.
ECapeInvalidArgument	One or more of the input arguments is not valid: for example, UNDEFINED value for the property argument or the phaseLabel argument.
ECapeUnknown	The error to be raised when other error(s), specified for the CheckSinglePhasePropSpec operation, are not suitable.