PropertyPackageGetCompoundConstant Method

Request Example View Source

Parameters

props  Object

The list of Physical Property identifiers. Valid identifiers for constant Physical Properties are listed in section 7.5.2.

compIds  Object

List of Compound identifiers for which constants are to be retrieved. Set compIds to UNDEFINED to denote all Compounds in the component that implements the ICapeThermoCompounds interface.

Return Value

Object
Values of constants for the specified Compounds.

Implements

ICapeThermoCompounds.GetCompoundConstant(Object, Object)

The GetConstPropList method can be used in order to check which constant Physical Properties are available. If the number of requested Physical Properties is P and the number of Compounds is C, the propvals array will contain C*P variants. The first C variants will be the values for the first requested Physical Property (one variant for each Compound) followed by C values of constants for the second Physical Property, and so on. The actual type of values returned (Double, String, etc.) depends on the Physical Property as specified in section 7.5.2. Physical Properties are returned in a fixed set of units as specified in section 7.5.2. If the compIds argument is set to UNDEFINED this is a request to return property values for all compounds in the component that implements the ICapeThermoCompounds interface with the compound order the same as that returned by the GetCompoundList method. For example, if the interface is implemented by a Property Package component the property request with compIds set to UNDEFINED means all compounds in the Property Package rather than all compounds in the Material Object passed to the Property package. If any Physical Property is not available for one or more Compounds, then undefined values must be returned for those combinations and an ECapeThrmPropertyNotAvailable exception must be raised. If the exception is raised, the client should check all the values returned to determine which is undefined.