ElecDeviceItf Interface CATIElbConnectionPoint
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbConnectionPoint
This interface provides access to connection point type, name and owner
Method Index
- o
GetConstraintElements(CATBaseUnknown**,CATBaseUnknown**,CATBaseUnknown**)
- To retrieve the constraint Elements of the connection point.
- o
GetName(CATUnicodeString&)
- To retrieve the Name of the connection point in a CATUniCodeString.
- o
GetOwner(CATIElbDeviceReference*&)
- To retrieve the Owner of the connection point as a pointer to the device reference.
- o
GetRepresentation(CATBaseUnknown**)
- To retrieve the Representation of the connection point.
- o
GetType(CnctPtType&)
- To retrieve the Type of the Connection Point in an
Enum CnctPtType already defined in CATIElbDeviceReference.
Methods
o GetConstraintElements
public virtual GetConstraintElements( | | opGeoElement1, |
| | opGeoElement2, |
| | opGeoElement3) |
-
To retrieve the constraint Elements of the connection point.
- Parameters:
-
- opGeoElement1
- : Element defining contact or connection point opGeoElement2 : Element defining coincidence or tangency
opGeoElement3 : Element defining orientation
both opGeoElement2 and opGeoElement3 can be NULL.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetName
public virtual GetName( | | oName) |
-
To retrieve the Name of the connection point in a CATUniCodeString.
- Parameters:
-
- oName
- The connection point name of type CATUnicodeString returned.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetOwner
public virtual GetOwner( | | oOwner) |
-
To retrieve the Owner of the connection point as a pointer to the device reference.
- Parameters:
-
- oOwner
- The pointer to the device reference which owns the connection point is returned.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetRepresentation
public virtual GetRepresentation( | | opCnctPtRepresentation) |
-
To retrieve the Representation of the connection point.
- Parameters:
-
- opCnctPtRepresentation
- The Representation of the connection point is returned.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetType
public virtual GetType( | | oType) |
-
To retrieve the Type of the Connection Point in an
Enum CnctPtType already defined in CATIElbDeviceReference.
- Parameters:
-
- oType
- The Connection Point type of type Enum CnctPtType returned.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
This object is included in the file: CATIElbConnectionPoint.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.