All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchCompFlow

System.IUnknown
  |
  +---CATISchCompFlow
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISchCompFlow

Interface to manage Schematic component's association with its internal flow objects.
Role: To modify component's links to its internal flow objects.


Method Index


o AddInternalFlow(CATIUnknownList*,CATISchInternalFlow**)
Add an internal flow to a component.
o AddInternalFlowSpecifyGRR(CATIUnknownList*,CATIUnknownList*,CATISchInternalFlow**)
Add an internal flow to a component.
o ListInternalFlows(CATIUnknownList**)
List all internal flow objects of a component.
o RemoveInternalFlow(CATISchInternalFlow*)
Remove an internal flow from a component.

Methods


o AddInternalFlow
public virtual HRESULT AddInternalFlow(CATIUnknownList* iLFlowCntrs,
CATISchInternalFlow** oInternalFlowAdded) = 0
Add an internal flow to a component.
Parameters:
iLFlowCntrs
List of connectors (2) to be connected by the flow. (members should be CATISchAppConnector interface pointer)
oInternalFlowAdded
Internal flow object added/created (CATISchInternalFlow interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AddInternalFlowSpecifyGRR
public virtual HRESULT AddInternalFlowSpecifyGRR(CATIUnknownList* iLFlowCntrs,
CATIUnknownList* iLOwnerGRR,
CATISchInternalFlow** oInternalFlowAdded) = 0
Add an internal flow to a component. Specifying which graphical images the connector graphics are on.
Parameters:
iLFlowCntrs
List of connectors (2) to be connected by the flow. (members should be CATISchAppConnector interface pointer)
iLOwnerImages
List of CATISchGRRComp interface pointers
oInternalFlowAdded
Internal flow object added/created (CATISchInternalFlow interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListInternalFlows
public virtual HRESULT ListInternalFlows(CATIUnknownList** oLInternalFlow) = 0
List all internal flow objects of a component.
Parameters:
oLInternalFlow
A list of internal flow objects (members are CATISchInternalFlow interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveInternalFlow
public virtual HRESULT RemoveInternalFlow(CATISchInternalFlow* iInternalFlowToRemove) = 0
Remove an internal flow from a component.
Parameters:
iInternalFlowToRemove
Internal flow object to be removed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchCompFlow.h

Copyright © 2003, Dassault Systèmes. All rights reserved.