All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPipeTubeDesignUseItf Interface CATIPipSupportInstance

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

interface CATIPipSupportInstance

Interface to access Support Instance.
Role: Access Support Instance.
New V6R2013 FD1
This interface is implemented by PLM Occurrence or Instance of Support.

Method Index

o GetPipeThroughSection(int,CATIPipPipeInstance*&): Retrieves the Pipe Instance passing through the support through specified section.
o GetReference(CATIPipSupportReference*&): Retrieves the Support Reference.

Methods

o GetPipeThroughSection

public virtual GetPipeThroughSection(		`iSectionNumber`,
		`oPipe`)

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

Parameters:

iSectionNumber: Section from which Pipe Instance passing through the support is required.
oPipe: [out, CATIPipPipeInstance#Release] Pipe 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, CATIPipSupportReference#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: CATIPipSupportInstance.h
If needed, your Imakefile.mk should include the module: CATPipeTubeDesignUseItf