All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Interface CATISchRouteGraphic
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchRouteGraphic
Interface to manage Schematic component's association with its
graphic representation objects.
Role: To modify component's links to its
graphical representations.
Method Index
- o
AddGraphicalPrimitive(CATISchGRRRoute*)
- Add a graphical primitive to a route.
- o
ListGraphicalPrimitives(CATIUnknownList**)
- List all graphical primitives of a route.
- o
RemoveAllGraphicalPrimitives()
- Remove all graphical primitives of a route, including alternate
graphical primitives.
- o
RemoveGraphicalPrimitive(CATISchGRRRoute*)
- Remove a graphical primitive from a route.
Methods
o AddGraphicalPrimitive
| public virtual AddGraphicalPrimitive( | | iGRRToAdd) |
-
Add a graphical primitive to a route.
- Parameters:
-
- iGRRToAdd
- The route graphical primitive to be added to the route.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListGraphicalPrimitives
| public virtual ListGraphicalPrimitives( | | oLGRR) |
-
List all graphical primitives of a route.
- Parameters:
-
- oLGRR
- A list of graphical primitives
(members are CATISchGRRRoute interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveAllGraphicalPrimitives
| public virtual RemoveAllGraphicalPrimitives( | ) |
-
Remove all graphical primitives of a route, including alternate
graphical primitives.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveGraphicalPrimitive
| public virtual RemoveGraphicalPrimitive( | | iGRRToRemove) |
-
Remove a graphical primitive from a route.
- Parameters:
-
- iGRRToRemove
- The route graphical primitive to be removed from the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchRouteGraphic.h