CapeThermoMaterialWrapperGetPhaseInfo Method

Returns information on an attribute associated with a Phase for the purpose of understanding what lies behind a Phase label.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
private string[] GetPhaseInfo(
	string phaseLabel,
	string phaseAttribute
)

Parameters

phaseLabel  String
A (single) Phase label. This must be one of the values returned by GetPhaseList method.
phaseAttribute  String
One of the Phase attribute identifiers from the table below.

Return Value

String
The value corresponding to the Phase attribute identifier – see table below.

Remarks

GetPhaseInfo is intended to allow a PME, or other client, to identify a Phase with an arbitrary label. A PME, or other client, will need to do this to map stream data into a Material Object, or when importing a Property Package. If the client cannot identify the Phase, it can ask the user to provide a mapping based on the values of these properties.

The list of supported Phase attributes is defined in the following table:

For example, the following information might be returned by a Property Package component that supports a vapour Phase, an organic liquid Phase and an aqueous liquid Phase: Phase label Gas Organic Aqueous StateOfAggregation Vapor Liquid Liquid KeyCompoundId UNDEFINED UNDEFINED Water ExcludedCompoundId UNDEFINED Water UNDEFINED DensityDescription UNDEFINED Light Heavy UserDescription The gas Phase The organic liquid Phase The aqueous liquid Phase TypeOfSolid UNDEFINED UNDEFINED UNDEFINED

Exceptions

ECapeNoImplThe operation 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..
ECapeInvalidArgument – phaseLabel is not recognised, or UNDEFINED, or phaseAttribute is not recognised.
ECapeUnknownThe error to be raised when other error(s), specified for this operation, are not suitable..

See Also