ElecHarnessItf Interface CATIEhiBranchEnd

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

interface CATIEhiBranchEnd

Interface to manage a segment end connection.

Method Index

o GetDistantLinkTarget(CATBaseUnknown**): Retrieve the segment end connected to the current segment end end through distant link.
o GetDistantLinkTarget(CATBaseUnknown**,CATBaseUnknown**): Retrieve the device connected to the current segment end end through distant link.
o IsTargetOfAnotherDistantLink(CATListValCATBaseUnknown_var**): Analyze if the current segment end is already a target of a distant link in session.
o RemoveDistantLink(): Remove the distant link from the current segment end to another segment end \ device instance.
o SetDistantLinkTarget(CATIEhiSegmentEnd*): Create a distant link between the current segment end and another segment end.
o SetDistantLinkTarget(CATBaseUnknown*,CATBaseUnknown*): Create a distant link between the current segment end and a device via a connection point.

Methods

o GetDistantLinkTarget

public virtual GetDistantLinkTarget( opConnectedSegmentEnd)

Retrieve the segment end connected to the current segment end end through distant link.

Parameters:

opConnectedSegmentEnd: The connected segment end .

Returns:

An HRESULT value.
Legal values:

S_OK: Distant link is successfully retrieved.
E_FAIL: Distant link does not exist.

o GetDistantLinkTarget

public virtual GetDistantLinkTarget(		`opIUnkDeviceConnectionPt`,
		`opIUnkDeviceInstance`)

Retrieve the device connected to the current segment end end through distant link.

Parameters:

opIUnkDeviceConnectionPt: The connected device instance connection point.
opIUnkDeviceInstance: The connected device instance.

Returns:

An HRESULT value.
Legal values:

S_OK: Distant link is successfully retrieved.
E_FAIL: Distant link does not exist.

o IsTargetOfAnotherDistantLink

public virtual IsTargetOfAnotherDistantLink( opListPointingExtremities = NULL)

Analyze if the current segment end is already a target of a distant link in session.

Parameters:

opListPointingExtremities: Default - NULL, if list of pointing extremities of current segment end is desired, then List should be passed

Returns:

An HRESULT value.
Legal values:

S_OK: Current segment end is already a target of a distant link in session.
E_FAIL: Current segment end is not a target of a distant link in session.

o RemoveDistantLink

public virtual RemoveDistantLink(

)

Remove the distant link from the current segment end to another segment end \ device instance.

Returns:

An HRESULT value.
Legal values:

S_OK: Distant link is successfully removed.
E_FAIL: Error.

o SetDistantLinkTarget

public virtual SetDistantLinkTarget( ipSegmentEndToConnect)

Create a distant link between the current segment end and another segment end.
The two objects will be considered as connected even they are not geometrically connected.
The current segment end must not be already connected (geometrically or by distant link) to enable distant link creation.
The target segment end must not have a distant link connection.

Parameters:

ipSegmentEndToConnect: A segment end.

Returns:

An HRESULT value.
Legal values:

S_OK: Distant link is successfully created.
S_FALSE: The current segment end has already a distant link to another segment end or device instance.
E_FAIL: The current segment end is already connected geometrically to another segment end.; The target has already a distant link to another segment end.

o SetDistantLinkTarget

public virtual SetDistantLinkTarget(		`ipIUnkDeviceConnectionPt`,
		`ipIUnkDeviceInstance`)

Create a distant link between the current segment end and a device via a connection point.
The two objects will be considered as connected even they are not geometrically connected.
The current segment end must not be already connected (geometrically or by distant link) to enable distant link creation.

Parameters:

ipIUnkDeviceConnectionPt: A connection point of a device.
ipIUnkDeviceInstance: A device instance.

Returns:

An HRESULT value.
Legal values:

S_OK: Distant link is successfully created.
S_FALSE: The current segment end has already a distant link to another device instance/segment end.
E_FAIL: The current segment end is already connected geometrically to another device instance.; The target has already a distant link to another segment end.

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