CATFunctionalModelerUseItf Interface CATIFctConnections
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIFctConnections
Interface dedicated to Functional Connections management.
Role: This interface manages the collection of Functional Connections aggregated by a Functional Reference.
To establish a connection or navigate between connected functions, see ,
and
.
Method Index
- o
Count(int&)
- Retrieves the number of Functional Connections aggregated by this Functional Reference.
- o
List(CATListValCATIFctConnection_var&)
- Retrieves the collection of connections aggregated by this Functional Reference.
- o
Remove(CATIFctConnection*)
- Removes the given Functional Connection.
Methods
o Count
| public virtual Count( | | oSize) |
-
Retrieves the number of Functional Connections aggregated by this Functional Reference.
- Parameters:
-
- oSize
- The number of Functional Connections.
- Returns:
-
S_OK The method succeeds and the number of Functional Connections is retrieved.
E_FAIL otherwise.
o List
| public virtual List( | | oLConnections) |
-
Retrieves the collection of connections aggregated by this Functional Reference.
- Parameters:
-
- oLConnections
- A list of functional connections.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.
- Returns:
-
S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.
o Remove
| public virtual Remove( | | ipLogicalConnectionToRemove) |
-
Removes the given Functional Connection.
Role: This method removes and deletes the given Functional Connection from the functional connections aggregated by this Functional Reference.
The given functional connection must be aggregated by this Functional Reference.
- Parameters:
-
- ipLogicalConnectionToRemove
- The functional connection to remove.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
- Returns:
-
S_OK if the method succeeds and the Functional Connection has been successfully removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.
This object is included in the file: CATIFctConnections.h
If needed, your Imakefile.mk should include the module: CATFunctionalModelerUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.