All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Interface CATISchAppComponent
Usage: you can freely reimplement this interface.
interface CATISchAppComponent
Interface to manage an application component object.
Role: Defines application component object behaviors
Method Index
- o
AppCreateComponentInst(IUnknown**)
- Create a component instance.
- o
AppCreateLocalReference(CATDocument*,IUnknown**)
- Create Local Reference object.
- o
AppGetDefaultGRRName2(CATUnicodeString&)
- Get the default graphical representation names
of an application component.
- o
AppGetDefaultGRRName(char**)
-
- o
AppListGRRNames2(CATListOfCATUnicodeString&)
- Find all the valid graphical representation names
of an application component.
- o
AppListGRRNames(CATICStringList**)
-
- o
AppOKToFlipConnected(CATBoolean*)
- Query whether it is OK to reconnect a component to
a different compatible configuration.
- o
AppOKToFlipHorizontal(CATBoolean*)
- Query whether it is OK to flip the application component about Y.
- o
AppOKToFlipOnLine(CATBoolean*)
- Query whether it is OK to flip a component about
its inserted line.
- o
AppOKToFlipVertical(CATBoolean*)
- Query whether it is OK to flip the application component about X.
- o
AppOKToPlaceInSpace(CATBoolean*)
- Query whether the application component can be placed in free space.
- o
AppOKToScale(CATBoolean*)
- Query whether it is OK to scale the application component.
- o
AppOKToSlide(CATBoolean*)
- Query whether the application component can be slided.
- o
AppOKToUninsert(CATBoolean*)
- Query whether it is OK to uninsert the application component.
- o
AppPostFlipConnectedProcess()
- Post process after reconnecting a component to
a different compatible configuration.
- o
AppPostFlipHorizontalProcess()
- Post process after flipping a component in "x".
- o
AppPostFlipOnLineProcess()
- Post process after flipping an inserted component
about the inserted line segment of the route.
- o
AppPostFlipVerticalProcess()
- Post process after flipping a component in "y".
- o
AppPostPlaceProcess(CATISchComponent*,CATISchAppConnectable*)
- Post process after placing an application component instance.
- o
AppPostSlideProcess()
- Post process after sliding a component.
- o
AppPostSwitchGraphicProcess(CATISchGRR*)
- Post process after switching a component's graphic representation.
- o
AppPostUninsertProcess(CATISchRoute*,CATISchRoute*,CATISchRoute*)
- Post process after uninserting a component, disconnecting
it from a route.
Methods
o AppCreateComponentInst
| public virtual AppCreateComponentInst( | | oNewAppCompInst) |
-
Create a component instance.
- Parameters:
-
- oNewAppCompInst
- Interface pointer (CATISchAppComponent) to the new application
component instance placed.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateLocalReference
| public virtual AppCreateLocalReference( | | iDocToCopyTo, |
| | oNewAppCompRef) |
-
Create Local Reference object. Given a reference object (the "this"),
This method make a copy of the reference into another document.
- Parameters:
-
- iDocToCopyTo
- Pointer to a document to copy the reference to,
- oNewAppCompRef
- Interface pointer (CATISchAppComponent) to the new application
component Reference copied.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppGetDefaultGRRName2
| public virtual AppGetDefaultGRRName2( | | oGRRDefaultName) |
-
Get the default graphical representation names
of an application component.
- Parameters:
-
- oGRRDefaultName
- The default name to be used for the graphical representation
of a component
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppGetDefaultGRRName
| public virtual AppGetDefaultGRRName( | | oGRRDefaultName) |
-
- Deprecated:
- V5R15
Use
CATISchAppComponent.AppGetDefaultGRRName2 instead. Get the default graphical representation names
of an application component.
- Parameters:
-
- oGRRDefaultName
- The default name to be used for the graphical representation
of a component
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppListGRRNames2
| public virtual AppListGRRNames2( | | oLGRRNames) |
-
Find all the valid graphical representation names
of an application component.
- Parameters:
-
- oLGRRNames
- A list of all the valid graphical representation names
with this connector for connections.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppListGRRNames
| public virtual AppListGRRNames( | | oLGRRNames) |
-
- Deprecated:
- V5R15
Use
CATISchAppComponent.AppListGRRNames2 instead. Find all the valid graphical representation names
of an application component.
- Parameters:
-
- oLGRRNames
- A list of all the valid graphical representation names
with this connector for connections.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToFlipConnected
| public virtual AppOKToFlipConnected( | | oBYes) |
-
Query whether it is OK to reconnect a component to
a different compatible configuration.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to flip the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToFlipHorizontal
| public virtual AppOKToFlipHorizontal( | | oBYes) |
-
Query whether it is OK to flip the application component about Y.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to flip the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToFlipOnLine
| public virtual AppOKToFlipOnLine( | | oBYes) |
-
Query whether it is OK to flip a component about
its inserted line.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to flip the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToFlipVertical
| public virtual AppOKToFlipVertical( | | oBYes) |
-
Query whether it is OK to flip the application component about X.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to flip the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToPlaceInSpace
| public virtual AppOKToPlaceInSpace( | | oBYes) |
-
Query whether the application component can be placed in free space.
- Parameters:
-
- oBYes
- If TRUE, the component can be slided.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToScale
| public virtual AppOKToScale( | | oBYes) |
-
Query whether it is OK to scale the application component.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to scale the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToSlide
| public virtual AppOKToSlide( | | oBYes) |
-
Query whether the application component can be slided.
- Parameters:
-
- oBYes
- If TRUE, the component can be slided.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppOKToUninsert
| public virtual AppOKToUninsert( | | oBYes) |
-
Query whether it is OK to uninsert the application component.
- Parameters:
-
- oBYes
- If TRUE, then it is OK to uninsert the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostFlipConnectedProcess
| public virtual AppPostFlipConnectedProcess( | ) |
-
Post process after reconnecting a component to
a different compatible configuration.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostFlipHorizontalProcess
| public virtual AppPostFlipHorizontalProcess( | ) |
-
Post process after flipping a component in "x".
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostFlipOnLineProcess
| public virtual AppPostFlipOnLineProcess( | ) |
-
Post process after flipping an inserted component
about the inserted line segment of the route.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostFlipVerticalProcess
| public virtual AppPostFlipVerticalProcess( | ) |
-
Post process after flipping a component in "y".
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostPlaceProcess
| public virtual AppPostPlaceProcess( | | iNewCompInst, |
| | iCntblConnectedTo) |
-
Post process after placing an application component instance.
- Parameters:
-
- iNewCompInst
- The newly placed component instance
(CATISchComponent interface pointer).
- iCntbleConnectedTo
- The connectable that the placed component is connected to or
placed onto
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostSlideProcess
| public virtual AppPostSlideProcess( | ) |
-
Post process after sliding a component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostSwitchGraphicProcess
| public virtual AppPostSwitchGraphicProcess( | | iGRR) |
-
Post process after switching a component's graphic representation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppPostUninsertProcess
| public virtual AppPostUninsertProcess( | | iOldAppRoute1, |
| | iOldAppRoute2, |
| | iNewAppRoute) |
-
Post process after uninserting a component, disconnecting
it from a route.
- Parameters:
-
- iOldAppRoute1
- One of the route that was connected
to one connector of the inserted
component before the operation.
- iOldAppRoute2
- The other route
that was connected to the other connector
of the inserted component before the operation.
This would be NULL if the component was connected at extremity.
- iNewAppRoute
- The new route
created after the operation.
This would be NULL if the component was connected at extremity.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchAppComponent.h