ICape Thermo Property PackageGet Component List Method
Definition
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
[DispIdAttribute(2)]
void GetComponentList(
ref Object compIds,
ref Object formulae,
ref Object names,
ref Object boilTemps,
ref Object molWt,
ref Object casNo
)<DispIdAttribute(2)>
Sub GetComponentList (
ByRef compIds As Object,
ByRef formulae As Object,
ByRef names As Object,
ByRef boilTemps As Object,
ByRef molWt As Object,
ByRef casNo As Object
)Parameters
- compIds Object
- Reference value to the list of component IDs. A reference to a System.Object containing a String array marshalled from a COM Object.
- formulae Object
- List of component formulae. A reference to a System.Object containing a String array marshalled from a COM Object.
- names Object
- List of component names. A reference to a System.Object containing a String array marshalled from a COM Object.
- boilTemps Object
- List of boiling point temperatures. A reference to a System.Object containing a double array marshalled from a COM Object.
- molWt Object
- List of molecular weight. A reference to a System.Object containing a double array marshalled from a COM Object.
- casNo Object
- List of CAS number. A reference to a System.Object containing a String array marshalled from a COM Object.
Remarks
Returns the list of components of a given property package.
In order to identify the components of a Property Package, the Executive will use the ‘casno’ argument instead of the compIds. The reason is that different COSEs may give different names to the same chemical compounds, whereas CAS Numbers are universal. Nevertheless, GetProp/SetProp... will still require their compIds argument to have the usual contents ("hydrogen", "methane",...). Be aware that some simulators may have a limitation on the length of the names for pure components. Hence, it is recommended that each identifier returned by the compIds argument should not contain more than 8 characters. See notes on Description of component constants for more information.
If the package does not return a value for the ‘casno’ argument, or its value is not recognised by the Executive, then the compIds will be interpreted as the component’s English name: such as "benzene", "water",... Obviously, it is recommended to provide a value for the casno argument.
The same information can also be extracted using the ICapeThermoPropertyPackage GetComponentConstant method, using the casRegistryNumber property identifier.
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. |