All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPipeTubeDesignUseItf Interface CATIPipSupportReference

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

interface CATIPipSupportReference

Interface to access Support Reference.
Role: Access Support Reference.
New V6R2013 FD1
This interface is implemented by Support VPMReference.

Method Index

o GetNumberOfSections(int&): Retrieves the number of Support sections.
o GetSectionData(int,CATMathPoint&,CATMathPlane&,CATMathPlane&,CATMathPlane&): Retrieves the Support Section Data.
o GetSubType(CATUnicodeString&): Retrieves the sub type Part of an Support.

Methods

o GetNumberOfSections

public virtual GetNumberOfSections( oNbSections)

Retrieves the number of Support sections.
Role: Retrieves the number of Support sections.

Parameters:

oNbSections: The number of Support sections.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_FAIL: Otherwise

o GetSectionData

public virtual GetSectionData(		`iSectionNumber`,
		`opiPoint`,
		`oPlane1`,
		`oPlane2`,
		`oBasePlane`)

Retrieves the Support Section Data.
Role: Retrieves the Support Section Data.

Parameters:

iSectionNumber: Section number used to read the data.
oPoint: The 3D mathematical point of the section.
oPlane1: The 3D mathematical input plane of the section.
oPlane2: The 3D mathematical output Plane of the section.
oBasePlane: The 3D mathematical base Plane of the section.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_FAIL: Otherwise

o GetSubType

public virtual GetSubType( oSubType)

Retrieves the sub type Part of an Support.
Role: Retrieves the sub type Part of an Support.

Parameters:

oSubType: The sub part type

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_FAIL: Otherwise

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