ElecDeviceItf Interface CATIElbDeviceInstance

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

interface CATIElbDeviceInstance

This interface is dedicated to the devices instance management.

Method Index

o Connect(CATBaseUnknown*,CATBaseUnknown*,CATBaseUnknown*): Connects two devices together.
o Disconnect(CATBaseUnknown*): Disconnects two devices connected together.
o GetConnectedDevice(CATBaseUnknown*,CATBaseUnknown*&,CATBaseUnknown*&): Get the device connected to the current device through a given connection point.
o GetInstanceName(CATUnicodeString&): To retrieve the Name of the device instance in a CATUniCodeString.
o GetType(CATUnicodeString&): To retrieve the Type of the device instance in a CATUniCodeString.
o ListSegmentEnds(CATBaseUnknown*,CATListValCATBaseUnknown_var*&): List the segment ends connected to the device through a segment connection point.

Methods

o Connect

public virtual Connect(		`ipFromCnctPt`,
		`ipToDevice`,
		`ipToCnctPt`)

Connects two devices together.

Parameters:

ipFromCnctPt: The connection point reference on which the other device will be connected
ipToDevice: The device instance that will be connected to the current device
ipToCnctPt: The connection point reference of the other device that will be implied in the 'connection'.

Returns:

S_OK if the method succeeds,
E_FAIL otherwise.

o Disconnect

public virtual Disconnect( ipToDevice)

Disconnects two devices connected together.

Parameters:

ipToDevice: The device instance that will be disconnected from the current device instance.

Returns:

S_OK if the method succeeds, or E_FAIL otherwise

o GetConnectedDevice

public virtual GetConnectedDevice(		`ipCnctPt`,
		`opDevice`,
		`opCnctPt`)

Get the device connected to the current device through a given connection point.

Parameters:

ipCnctPt: The connection point on which the searched device is connected The connection point can be a Cavity, a CavityCnctPt, a ShellCnctPt, a ConnectorCnctPt or a BackShellCnctPt.
opDevice: The device instance connected to the current device
opCnctPt: The connection point reference of the searched device implied in the 'connection'.

Returns:

S_OK if the method succeeds,
E_FAIL otherwise.

o GetInstanceName

public virtual GetInstanceName( oStrInstanceName)

To retrieve the Name of the device instance in a CATUniCodeString.

Parameters:

oInstanceName: The device instance name of type CATUnicodeString returned.

Returns:

S_OK if the method succeeds, or E_FAIL otherwise

o GetType

public virtual GetType( oStrType)

To retrieve the Type of the device instance in a CATUniCodeString.

Parameters:

oType: The device instance type of type CATUnicodeString returned.

Returns:

S_OK if the method succeeds, or E_FAIL otherwise

o ListSegmentEnds

public virtual ListSegmentEnds(		`ipCnxPt`,
		`opLSegmentEnds`)

List the segment ends connected to the device through a segment connection point.

Parameters:

ipCnxPt: The Segment Connection point on which the segment ends are connected
opLSegmentEnds: The list of segment ends

Returns:

S_OK if the method succeeds, or E_FAIL otherwise

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