All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Interface CATISchInternalFlow
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchInternalFlow
Interface to query Schematic internal flow information
on a component.
Role: To query internal flow properties.
Method Index
- o
GetInsertionType(CATSchInternalFlowType*)
- Get insertion flow type.
- o
GetStatus(CATSchInternalFlowStatus*)
- Get insertion flow status.
- o
ListSchConnectors(CATIUnknownList**)
- List all schematic connectors associated with an internal flow.
- o
SetStatus(CATSchInternalFlowStatus)
- Set insertion flow status.
Methods
o GetInsertionType
| public virtual GetInsertionType( | | oEInternalFlowType) |
-
Get insertion flow type.
- Parameters:
-
- oEInternalFlowType
- Internal flow type.
- See also:
- CATSchInternalFlowType
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetStatus
| public virtual GetStatus( | | oEInternalFlowStatus) |
-
Get insertion flow status.
- Parameters:
-
- oEInternalFlowStatus
- Internal flow status.
- See also:
- CATSchInternalFlowStatus
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListSchConnectors
| public virtual ListSchConnectors( | | oLSchCntrs) |
-
List all schematic connectors associated with an internal flow.
- Parameters:
-
- oLSchCntrs
- A list of schematic connector objects
(members are CATISchCntrLocation interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetStatus
| public virtual SetStatus( | const | iEInternalFlowStatus) |
-
Set insertion flow status.
- Parameters:
-
- iEInternalFlowStatus
- Internal flow status.
- See also:
- CATSchInternalFlowStatus
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchInternalFlow.h