MaterialObjectWrapperGetProp Method

Get some pure component constant(s)

Definition

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

public double[] GetProp(
	string property,
	string phase,
	string[] compIds,
	string calcType,
	string basis
)

VBRequest Example

Public Function GetProp ( 
	property As String,
	phase As String,
	compIds As String(),
	calcType As String,
	basis As String
) As Double()

Parameters

property String: The Property for which results are requested from the MaterialObject.
phase String: The qualified phase for the results.
compIds String: The qualified components for the results. Use a null value to specify all components in the Material Object. For mixture property such as liquid enthalpy, this qualifier is not required. Use emptyObject as place holder.
calcType String: The qualified type of calculation for the results. (valid Calculation Types: Pure and Mixture)
basis String: Qualifies the basis of the result (i.e., mass /mole). Default is mole. Use NULL for default or as place holder for property for which basis does not apply (see also Specific properties.

Return Value

Double
Results vector containing property values in SI units arranged by the defined qualifiers. The array is one dimensional containing the properties, in order of the "props" array for each of the compounds, in order of the compIds array.

Remarks

This method is responsible for retrieving the results from calculations from the MaterialObject. See Notesfor a more detailed explanation of the arguments.

Exceptions

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