ICapeMaterialTemplateSystemCreateMaterialTemplate Method

Creates a new thermo material template of the specified type.

Definition

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

[DispIdAttribute(2)]
Object CreateMaterialTemplate(
	string materialTemplateName
)

VBRequest Example

<DispIdAttribute(2)>
Function CreateMaterialTemplate ( 
	materialTemplateName As String
) As Object

Parameters

materialTemplateName String: TThe name of the material template to be resolved (which must be included in the list returned by MaterialTemplates)

Return Value

Object
Returns StringArray of material template names supported by the COSE. This can include: - CAPE-OPEN standalone property packages - CAPE-OPEN property packages that depend on a Property System - Property packages that are native to the COSE.

Remarks

When a Unit Operation needs to obtain thermodynamic calculations, it will typically perform them on the material objects attached to the Unit ports. However, in some cases, like distillation columns, there may be the need to utilise a different Property Package. Even the user could be requested to choose which thermodynamic model to must be used. All the mechanisms for accessing CAPE-OPEN Property Packages are already in the COSE´s, as part of the functionality necessary for making use of CAPE-OPEN Property Packages. Therefore, instead of each PMC implementing support for performing this selection and creation of thermo engine, delegating that responsibility to the COSE will result in thinner and easier to code Unit Operation Components. If configuration of Material Templates is in the PME side, the only additional functionality the Unit Operation would require is that for accessing the list of already configured Material Templates, and picking one of them.

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.