CATLogicalModelerUseItf CATLogConnectionPoint
Usage: you must use this class as is. You should never derive it.
public class CATLogConnectionPoint
Class made for Logical Connection Point.
RoleThe class provides means to create, manage and compare Connection Points
Constructor and Destructor Index
- o
~CATLogConnectionPoint()
- Destructor.
Method Index
- o
Compare(CATLogConnectionPoint*)
- Compare this Connection Point to the given Connection Point.
- o
CreateLogicalConnectionPoint(CATListValCATBaseUnknown_var&,CATLogConnectionPoint*&)
- Create a Logical Connection Point.
- o
GetLogicalReference(CATILogReference*&)
- Get the Father Logical Reference of the Connection Point.
- o
GetPath(CATListValCATBaseUnknown_var&)
- Get the path of the Connection Point.
Constructor and Destructor
o ~CATLogConnectionPoint
| public virtual ~CATLogConnectionPoint( | ) |
-
Destructor.
Methods
o Compare
| public Compare( | | ipLogicalCnxPointToCompare) |
-
Compare this Connection Point to the given Connection Point.
- Parameters:
-
- ipLogicalCnxPointToCompare
- The Connection Point to compare to this.
Input parameter
This parameter MUST NOT be provided by caller as NULL. This method returns FALSE otherwise.
- Returns:
-
TRUE if the method succeeds and Connection Point are the same.
FALSE if the Connection Point are different.
o CreateLogicalConnectionPoint
| public static CreateLogicalConnectionPoint( | | iLPathOfElements, |
| | opConnectionPoint) |
-
Create a Logical Connection Point.
- Parameters:
-
- iLPathOfElements
- Input parameter
This list MUST not be EMPTY. It must contains the path of the connection point. This method returns E_INVALIDARG otherwise.
- opConnectionPoint
- The created Connection Point
This parameter is valuated if method succeeds
Output parameter
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if input parameters are unexpected.
E_FAIL otherwise.
o GetLogicalReference
| public GetLogicalReference( | | opLogicalReference) |
-
Get the Father Logical Reference of the Connection Point.
- Parameters:
-
- opLogicalReference
- [out, CATBaseUnknown#Release]
This parameter is valuated if method succeeds
Father Logical Reference of this.
Output parameter
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if input parameters are unexpected.
E_FAIL otherwise.
o GetPath
| public GetPath( | | oLPathOfElements) |
-
Get the path of the Connection Point.
- Parameters:
-
- oLPathOfElements
- This parameter is valuated if method succeeds
Output parameter
This list MUST be provided by caller as EMPTY. This method returns E_INVALIDARG otherwise.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if input parameters are unexpected.
E_FAIL otherwise.
This object is included in the file: CATLogConnectionPoint.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.