All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchNetworkAnalysis
System.IUnknown
|
+---CATISchNetworkAnalysis
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchNetworkAnalysis
Interface to analysis a schematic network (a set of connectioned
objects).
Role: To analysis the connectivity of objects.
Method Index
- o
FindPaths(CATISchAppConnectable*,CATISchAppConnectable*,CATIUnknownList**)
- Given a start and end object in the network, this method returns
a list of network objects each representing a path connecting the
the 2 input objects.
- o
ListExtremityObjects(CATIUnknownList**)
- List the extremity objects of the network.
- o
ListNetworkObjects(CATIUnknownList**)
- List the connected objects in the network.
Methods
o FindPaths
-
Given a start and end object in the network, this method returns
a list of network objects each representing a path connecting the
the 2 input objects.
- Parameters:
-
- iFromObject
- The connectable to start from.
- iToObject
- The connectable to finish at.
- oLNetworks
- Pointer to a list of networks.
(Members are CATISchNetworkAnalysis interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListExtremityObjects
-
List the extremity objects of the network.
- Parameters:
-
- oLExtremityObjs
- Pointer to a list of extremity objects of the network
(Members are CATISchAppConnectable interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListNetworkObjects
-
List the connected objects in the network.
- Parameters:
-
- oLNetworkObjs
- Pointer to a list of all connected objects in the network.
(Members are CATISchAppConnectable interface pointers)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchNetworkAnalysis.h