All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchRouteGraphic

System.IUnknown
  |
  +---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 HRESULT AddGraphicalPrimitive(CATISchGRRRoute* iGRRToAdd) = 0
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 HRESULT ListGraphicalPrimitives(CATIUnknownList** oLGRR) = 0
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 HRESULT RemoveAllGraphicalPrimitives()= 0
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 HRESULT RemoveGraphicalPrimitive(CATISchGRRRoute* iGRRToRemove) = 0
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

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