ElecDeviceItf Interface CATIElbDeviceReference
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbDeviceReference
This interface is dedicated to the device management.
Method Index
- o
AddConnectionPoint(CnctPtType,CATUnicodeString&,CATBaseUnknown*,CATListValCATBaseUnknown_var*,CATBaseUnknown*&)
- Add a Connection Point to the device.
- o
GetPartNumber(CATUnicodeString&)
- To retrieve the Part Number of the corresponding device reference
- o
GetType(CATUnicodeString&)
- To retrieve the Type of the corresponding device reference in a CATUnicodeString.
- o
ListConnectionPoints(CnctPtType,CATListValCATBaseUnknown_var*&)
- List the connection points of type iType.
- o
RemoveConnectionPoint(CATBaseUnknown*)
- Remove the given connection point.
Methods
o AddConnectionPoint
| public virtual AddConnectionPoint( | const | iType, |
| const | icusId, |
| | ipRepresentation, |
| | ipJointReferences, |
| | opCnxPt) |
-
Add a Connection Point to the device.
- Parameters:
-
- iType
- The type identifying the connection point
- icusId
- The identifier of the Connection Point
- ipRepresentation
- The representation of the Connection Point
- ipJointReferences
- The geometrical elements associated to the port
- Used to constraint the device placement for the 'old' CnctPt version
- NULL: No associated geometrical elements for the default CnctPt version
- opCnxPt
- The created Port
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetPartNumber
| public virtual GetPartNumber( | | oStrPartNumber) |
-
To retrieve the Part Number of the corresponding device reference
- Parameters:
-
- oPartNumber
- The PartNumber of the dveice reference in a CATUnicodeString
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetType
| public virtual GetType( | | oStrType) |
-
To retrieve the Type of the corresponding device reference in a CATUnicodeString.
- Parameters:
-
- oType
- The PartNumber of the device reference in a CATUnicodeString.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o ListConnectionPoints
| public virtual ListConnectionPoints( | const | iType, |
| | opLCnxPt) |
-
List the connection points of type iType.
- Parameters:
-
- iType
- The Type of the connection point
- opLCnxPt
- The list of connection points
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o RemoveConnectionPoint
| public virtual RemoveConnectionPoint( | | ipCnxPt) |
-
Remove the given connection point.
- Parameters:
-
- ipCnxPt
- The connection point to remove
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
This object is included in the file: CATIElbDeviceReference.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.