All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchGapDisplay

System.IUnknown
  |
  +---CATISchGapDisplay
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISchGapDisplay

Interface to manage gap display attributes on routes.
Role: To add/remove gap display attributes on routes.


Method Index


o IsGapShown(CATBoolean*)
Query whether gaps are shown (gap attributes exist).
o SetGap(CATIUnknownList*)
Add gap display attributes on the route.
o UnsetGap(CATIUnknownList*)
Remove gap display attributes on the route.

Methods


o IsGapShown
public virtual HRESULT IsGapShown(CATBoolean* oBYes) = 0
Query whether gaps are shown (gap attributes exist).
Parameters:
oBYes
If TRUE, then gaps are shown (gap attributes exist). If FALSE, then gaps are not shown (gap attributes do not exist).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetGap
public virtual HRESULT SetGap(CATIUnknownList* iLUKRoutes= NULL) = 0
Add gap display attributes on the route.
Parameters:
iLUKRoutes
A list of routes to be processed, default is NULL (if NULL, then all routes in model are processed). Members are CATISchRoute interface pointers.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o UnsetGap
public virtual HRESULT UnsetGap(CATIUnknownList* iLUKRoutes= NULL) = 0
Remove gap display attributes on the route. A list of routes to be processed, default is NULL (if NULL, then all routes in model are processed). Members are CATISchRoute interface pointers.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchGapDisplay.h

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