All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATHvacDesignUseItf Interface CATIHvaSupportInstance

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIHvaSupportInstance

Interface to access Support Instance.
Role: Access Support Instance.
This interface is implemented by PLM Occurrence Support.

Method Index

o GetDuctThroughSection(int,CATIHvaDuctInstance*&): Retrieves the Duct Instance passing through the support through specified section.
o GetReference(CATIHvaSupportReference*&): Retrieves the Support Reference.

Methods

o GetDuctThroughSection

public virtual GetDuctThroughSection(		`iSectionNumber`,
		`oDuct`)

Retrieves the Duct Instance passing through the support through specified section.
Role: Retrieves the Duct Instance passing through a specified section.

Parameters:

iSectionNumber: Section from which Duct Instance passing through the support is required.
oDuct: [out, CATIHvaDuctInstance#Release] Duct Instance passing through the support through specified section.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_INVALIDARG: One of the input argument is invalid
E_FAIL: Otherwise

o GetReference

public virtual GetReference( opiSupport)

Retrieves the Support Reference.
Role: Retrieves the Support Reference.

Parameters:

opiSupport: [out, CATIHvaSupportReference#Release] Interface pointer on Support Reference.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_INVALIDARG: The input argument opiSupport is not NULL
E_FAIL: Otherwise

This object is included in the file: CATIHvaSupportInstance.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf