All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPipeTubeDesignUseItf Interface CATIPipEquipmentReference

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

interface CATIPipEquipmentReference

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

Method Index

o CreatePort(CATMathPoint&,CATMathVector&,CATMathVector&,CATIPipPipingPortRef::CATPipGeomPortTypeEnum&,CATUnicodeString&,CATIPipPipingPortRef*&,CATMathPoint*): Create a Piping Port on a Equipment
o GetSubType(CATUnicodeString&): Retrieves the sub type Part of an Equipement.
o ListPorts(CATLISTPOfCATIPipPipingPortRef&): Retrieves the list of Piping Ports.

Methods

o CreatePort

public virtual CreatePort(	const	`iOriginPoint`,
	const	`iAlignmentDirection`,
	const	`iOrientationDirection`,
	const	`iPortType`,
	const	`iuPortName`,
		`opIPipPipingPortRef`,
		`ipOffsetPoint`	`=NULL` )

Create a Piping Port on a Equipment

Parameters:

iOriginPoint: [in, CATMathPoint]. Origin of a Piping Port
iAlignmentDirection: [in, CATMathVector]. Alignment Direction - X Axis
iOrientationDirection: [in, CATMathVector]. Orientation Direction - Z Axis
iPortType: [in, CATPipGeomPortTypeEnum]. Port Type
iuPortName: [in, CATUnicodeString] Port Name. It should be a unique name for a port, not used for existing ports on the Equipment.
opIPipPipingPortRef: [out, CATIPipPipingPortRef#Release] Created Port.
ipOffsetPoint: [in, optional] Pointer to Offset Point in case of "2 Pt Part Port" or "2 Pt Hole Port". In this case, input iAlignmentDirection is NOT taken into considerderation.

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_FAIL: operation failed
E_INVALIDARG: Either Alignment and Orienation vectors are not orthogonal or the input name for port is already used.

o GetSubType

public virtual GetSubType( oSubType)

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

Parameters:

oSubType: The sub part type

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_FAIL: Otherwise

o ListPorts

public virtual ListPorts( oLptrPort)

Retrieves the list of Piping Ports.
Role: Retrieves the list of Piping Ports.

Parameters:

oLptrPort: List of all ports of this object. Each pointer of the list has to be released.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
E_INVALIDARG: The input argument oLptrPort is not empty
E_FAIL: Otherwise

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