All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPipeTubeDesignUseItf Interface CATIPipPipeInstance

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

interface CATIPipPipeInstance

Interface to access Rigid and Flexible Pipe Instance.

Role: Retrieve the connected Rigid Pipe, Flexible Pipe, Piping part, Equipment link to the branch port or Pipe/Tube end This interface is implemented by PLM Occurrence or Instance of Rigid Pipe or Flexible Pipe.

Method Index

o GetConnectedObject(CATIPipPipingPortRef*&,CATBaseUnknown*&,CATIPipPipingPortRef*): Gets the other connectable object and Port at this Port.
o GetLinkedSupports(CATLISTP(CATIPipSupportInstance)&,CATListOfInt*,CATListOfInt*): Retrieves the list of Support Instances linked to the Pipe Instance.
o GetReference(CATBaseUnknown*&): Gets the PLM reference of corresponding Pipe Occurrence.
o GetRelatedObject(CATLISTP(CATBaseUnknown)*&): Gets the related object in term of insulation, Piping part with Hole port and support.
o GetSpool(CATIPipSpoolInstance*&): Finds the Spool of current pipe if any.
o ListGeometricalBranch(CATLISTP(CATBaseUnknown)*&,CATListOfDouble&): Gets the list of all geometrical branch.

Methods

o GetConnectedObject

public virtual GetConnectedObject(		`opiOtherPort`,
		`opiOtherConnectable`,
		`ipiThisPort`)

Gets the other connectable object and Port at this Port.

Parameters:

opIOtherConnectable: A connected object [out, CATBaseUnknown#Release].
opIOtherPort: A Port of the other connected object [out, CATIPipPipingPortRef#Release].
ipIThisPort: A Port of this object. (Branch Port or Pipe/tube End) [in, CATIPipPipingPortRef].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: ipiThisPort argument is NULL or output argument pointer(s) is(are) NOT NULL
E_FAIL: operation failed

o GetLinkedSupports

public virtual GetLinkedSupports(	`oLptrSupportInstance`,
	`opListOfSupportRefPoints`	`= NULL`,
	`opListOfSupportProjectPoints`	`= NULL`)

Retrieves the list of Support Instances linked to the Pipe Instance.
Role: Retrieves the list of Support Instances linked to the Pipe Instance.
New V6R2013 FD1

Parameters:

oLptrSupport: List of Support Instances linked to the Pipe Instance. The list can be empty. Each pointer of the list has to be released.
opListOfSupportRefPoints: [out, optional] Pointer to the List of nodes on the route which are reference points on support.
opListOfSupportProjectPoints[out,: optional] Pointer to the List of nodes on the route which are projected points on support.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
S_FALSE: Operation is successful, but current Pipe does not have any support linked.
E_INVALIDARG: The input argument oLptrSupport is not empty
E_FAIL: Otherwise

o GetReference

public virtual GetReference( opIPipeReference)

Gets the PLM reference of corresponding Pipe Occurrence.
Postcondition This method can return a Rigid or Flexible pipe.

Parameters:

opIPipeReference

A pointer on reference [out, CATBaseUnknown]. An HRESULT value.
Legal values:

E_INVALIDARG: output pointer is NOT NULL
S_OK: operation is successful
E_FAIL: operation failed

o GetRelatedObject

public virtual GetRelatedObject( opListObject)

Gets the related object in term of insulation, Piping part with Hole port and support.

Parameters:

opListObject: A list of related object to Pipe/Tube [out, CATLISTP(CATBaseUnknown) #Release].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: output pointer is NOT NULL
E_FAIL: operation failed

o GetSpool

public virtual GetSpool( opISpoolInstance)

Finds the Spool of current pipe if any.

Parameters:

opISpoolInstance[out,: CATIPipPipeInstance#Release]. Interface pointer on spool occurence Can be NULL if current pipe is not in any spool .

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
S_FALSE: Operation is successful, but current pipe is not in any spool.
E_INVALIDARG: The input argument opISpoolInstance is not NULL
E_FAIL: Otherwise

o ListGeometricalBranch

public virtual ListGeometricalBranch(		`opListPipe`,
		`opListCurvilinearLength`)

Gets the list of all geometrical branch.

Parameters:

opListPorts: List of all Pipes that it is connected on main pipe by geometrical connection. [out, CATLISTP(CATBaseUnknown)]
opListCurvilinearLength: List of curvilinear position of secondary pipe on main Pipe curve. This list has the same size of opListPorts. There is a mapping where same index is same port. [out, CATListOfDouble]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: output list pointer is NOT NULL and/or the other output list is not empty
E_FAIL: operation failed

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