All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppCompatible

System.IUnknown
  |
  +---CATISchAppCompatible
 

Usage: you can freely reimplement this interface.


interface CATISchAppCompatible

Interface to query an application component whether an application route or component can be connected.
Role: Defines connection rules.


Method Index


o AppIsTargetOKForInsert(CATIUnknownList*,CATIUnknownList**,CATBoolean*)
Query whether a component (source) is compatible to be inserted into this route.
o AppIsTargetOKForPlace(CATIUnknownList*,CATIUnknownList**,CATBoolean*)
Query whether a component (source) is compatible to be connected to "this" object (the target, which can be a route or a component).
o AppIsTargetOKForRoute(char*,CATIUnknownList**,CATBoolean*)
Query whether a route of the input class type can be connected to "this" object (the target, which can be a route or a component).

Methods


o AppIsTargetOKForInsert
public virtual HRESULT AppIsTargetOKForInsert(CATIUnknownList* iLCompSourceCntrs,
CATIUnknownList** oLSourceCntrs,
CATBoolean* oBYes) = 0
Query whether a component (source) is compatible to be inserted into this route. This method is used when inserting a component into a route. This mehtod should only be implemented on a route object. For a component object, the method should simply returns oBYes=FALSE.
Parameters:
iLCompSourceCntrs
A list of connectors on the source component. The target (to be connected) is "this" route.
oLSourceCntrs
A list of compatible and available connectors on the source component (the input) that can be connected to the target ("this" route) (members are CATISchAppConnector interface pointers)
oBYes
If TRUE, the object is OK to be connected to a route.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppIsTargetOKForPlace
public virtual HRESULT AppIsTargetOKForPlace(CATIUnknownList* iLCompSourceCntrs,
CATIUnknownList** oLTargetCntrs,
CATBoolean* oBYes) = 0
Query whether a component (source) is compatible to be connected to "this" object (the target, which can be a route or a component). This method is used when placing a component to be connected to another object.
Parameters:
iLCompSourceCntrs
A list of connectors on the source component. The target (to be connected) is "this" component.
oLOKCntrs
A list of compatible and available connectors on "this" component (the target) to be connected to the source component (the input source). (members are CATISchAppConnector interface pointers)
oBYes
If TRUE, the object is OK to be connected to a route.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppIsTargetOKForRoute
public virtual HRESULT AppIsTargetOKForRoute( const char* iRouteCntrClassType,
CATIUnknownList** oLOKCntrs,
CATBoolean* oBYes) = 0
Query whether a route of the input class type can be connected to "this" object (the target, which can be a route or a component). This method is used when routing a route.
Parameters:
iRouteCntrClassType
Class type of a schematic route connector.
oLOKCntrs
A list of compatible and available connectors on this object. (members are CATISchAppConnector interface pointers)
oBYes
If TRUE, the object is OK to be connected to a route.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppCompatible.h

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