All Frameworks  Object Hierarchy  This Framework  Indexes

SchGRRRoute (Object)

Manage the graphical representations of a schematic route.

AddPoints: Add a list of point to a route.
Break: Break a route graphic into 2 pieces.
Compress2: Compress the defining points of a route graphic, removing coincident points.
Compress: Compress a the defining points of a route graphic, removing coincident points.
ConcatenateKeepGRR2: Concatenate 2 route graphic objects into one.
Concatenate: Concatenate 2 route graphic objects into one.
CreateRouteSymbol: Place a symbol on the route.
GetEndPoint: Get the end point of the route graphic.
GetPath: Get the defining points of a route graphic.
GetStartPoint: Get the start point of the route graphic.
ListRouteSymbols: List route symbols on the route.
RemovePoints: Remove points from route graphic.
SetEndPoint: Set the end point of the route graphic.
SetPath2: Set the defining points of a route graphic.
SetPath3: Set the defining points of a route graphic.
SetPath: Set the defining points of a route graphic.
SetStartPoint: Set the start point of the route graphic.

Methods

o Sub AddPoints(		`iLDb2PtPathToAdd`,
		`iAfterWhichPtNum`)

Add a list of point to a route.

Parameters:

iLDbPtPathToAdd: A list of X-Y coordinates of the points to be added. 2 doubles per point.
iAfterWhichPtNum: The point number to add the points after. Use 0 to indicate adding before the first point.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(x) As CATSafeArrayVariant
 Dim intVar3 As Integer
  ...
 objThisIntf.AddPointsdbVar1,intVar3

o Sub Break(		`iDb2Pt1`,
		`iDb2Pt2`,
		`oNewGRRRoute`)

Break a route graphic into 2 pieces. The old graphic is shortened and a new graphic is created.

Parameters:

iDb2Pt1: X-Y coordinates of point 1 to break the route at (this point is mandatory).
iDb2Pt2: X-Y coordinates of point 2 to break the route at (this point is optional). If provided the points in between point 1 and this point will be eliminated. Point 1 is the last point of the shortened old route and point 2 is the first point of the new route. If this point is not provided (i.e. sends in a NULL). point 1 and point 2 are the same.
oNewGRRRoute: The new line string graphic created (CATISchGRRRoute interface pointer)

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(2) As CATSafeArrayVariant
 Dim dbVar2(2) As CATSafeArrayVariant
 Dim objArg3 As SchGRRRoute
  ...
 objThisIntf.BreakdbVar1,dbVar2,objArg3

o Sub Compress2( iUnsetGaps)

Compress the defining points of a route graphic, removing coincident points.

Parameters:

iUnsetGaps: Whether to unset gaps (in all the effected routes: this route and other routes intersecting it) or not = SchUnsetGapsOn : unset gaps = SchUnsetGapsOff : don't unset gaps

Example:

 Dim objThisIntf As SchGRRRoute

  ...
 objThisIntf.Compress2CatSchIDLRouteUnsetGapsMode_Enum

o Sub Compress(

)

Compress a the defining points of a route graphic, removing coincident points.

Example:

 Dim objThisIntf As SchGRRRoute
  ...
 objThisIntf.Compress

o Sub ConcatenateKeepGRR2(		`iWhichEnd1`,
		`iGRRRoute2`,
		`iWhichEnd2`)

Concatenate 2 route graphic objects into one. The first route graphic is elongated and the second object is unchanged.

Parameters:

iWhichEnd1: =1 at start point; =2 at end point
iGRRRoute2: Second route graphic object (CATISchGRRRoute interface pointer) to be concatenated to the first. This route graphic will be unchanged.
iWhichEnd2: =1 at start point; =2 at end point

Example:

 Dim objThisIntf As SchGRRRoute
 Dim intVar1 As Integer
 Dim objArg2 As SchGRRRoute
 Dim intVar3 As Integer
  ...
 objThisIntf.ConcatenateKeepGRR2intVar1,objArg2,intVar3

o Sub Concatenate(		`iWhichEnd1`,
		`iGRRRoute2`,
		`iWhichEnd2`)

Concatenate 2 route graphic objects into one. The first route graphic is elongated and the second object is deleted.

Parameters:

iWhichEnd1: =1 at start point; =2 at end point
iGRRRoute2: Second route graphic object (CATISchGRRRoute interface pointer) to be concatenated to the first. This route graphic will be deleted.
iWhichEnd2: =1 at start point; =2 at end point

Example:

 Dim objThisIntf As SchGRRRoute
 Dim intVar1 As Integer
 Dim objArg2 As SchGRRRoute
 Dim intVar3 As Integer
  ...
 objThisIntf.ConcatenateintVar1,objArg2,intVar3

o Sub CreateRouteSymbol(		`iSegNum`,
		`iSegParm`,
		`iGRRSymbol`,
		`oRouteSymbol`)

Place a symbol on the route.

Parameters:

iSegNum: The route segment number to place the symbol on.
iSegParm: The parameter along the segment used to place the symbol on (0.<=iSegParm<=1.).
iGRRSymbol: The graphical primitive (detail) to be used for the symbol.
oRouteSymbol: The created route symbol (ditto).

Example:

 Dim objThisIntf As SchGRRRoute
 Dim intVar1 As Integer
 Dim dbVar2 As Double;
 Dim objArg3 As SchGRR
 Dim objArg4 As SchRouteSymbol
  ...
 objThisIntf.CreateRouteSymbolintVar1,dbVar2,objArg3,objArg4

o Sub GetEndPoint( oDb2EndPt)

Get the end point of the route graphic.

Parameters:

oDb2EndPt: X-Y coordinates of the end point of the route graphic object.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim objArg1 As SchListOfDoubles
  ...
 objThisIntf.GetEndPointobjArg1

o Sub GetPath( oLDb2PtPath)

Get the defining points of a route graphic.

Parameters:

oLDbPtPath: A list of X-Y coordinates of the points. 2 doubles per point.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim objArg1 As SchListOfDoubles
 Dim intVar2 As Integer
  ...
 objThisIntf.GetPathobjArg1

o Sub GetStartPoint( oDb2StartPt)

Get the start point of the route graphic.

Parameters:

oDb2StartPt: X-Y coordinates of the start point of the route graphic object.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim objArg1 As SchListOfDoubles
  ...
 objThisIntf.GetStartPointobjArg1

o Func ListRouteSymbols(

) As

List route symbols on the route.

Parameters:

oLRouteSymbol: A list of route symbols. (members are CATIASchRouteSymbol objects).

Example:

 Dim objThisIntf As SchGRRRoute
 Dim objArg1 As SchListOfObjects
  ...
 Set objArg1 = objThisIntf.ListRouteSymbols

o Sub RemovePoints(		`iNumOfPtsToRemove`,
		`iAfterWhichPtNum`)

Remove points from route graphic.

Parameters:

iNumOfPtsToRemove: The number of points to be removed
iAfterWhichPtNum: The point number at which to start removing the point.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim intVar1 As Integer
 Dim intVar2 As Integer
  ...
 objThisIntf.RemovePointsintVar1,intVar2

o Sub SetEndPoint( iDb2EndPt)

Set the end point of the route graphic.

Parameters:

iDb2EndPt: X-Y coordinates of the end point of the route graphic object to be set.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(2) As CATSafeArrayVariant
  ...
 objThisIntf.SetEndPointdbVar1

o Sub SetPath2(		`iLDb2PtPath`,
		`iCompress`,
		`iUnsetGaps`)

Set the defining points of a route graphic.

Parameters:

iLDbPtPath: A list of X-Y coordinates of the points to be set. 2 doubles per point.
iCompress: Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.) or not = SchCompressOn : compress = SchCompressOff : don't compress
iUnsetGaps: Whether to unset gaps (in all the effected routes: this route and other routes intersecting it) or not = SchUnsetGapsOn : unset gaps = SchUnsetGapsOff : don't unset gaps

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(x) As CATSafeArrayVariant

  ...
 objThisIntf.SetPath2dbVar1,CatSchIDLRouteCompressMode_Enum,CatSchIDLRouteUnsetGapsMode_Enum

o Sub SetPath3(		`iLDb2PtPath`,
		`iCompress`,
		`iUnsetGaps`,
		`iRouteUpdateSymbols`)

Set the defining points of a route graphic.

Parameters:

iLDb2PtPath: A list of X-Y coordinates of the points to be set. 2 doubles per point.
iCompress: Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.) or not = catSchIDLCompressOn : compress = catSchIDLCompressOff : don't compress
iUnsetGaps: Whether to unset gaps (in all the effected routes: this route and other routes intersecting it) or not = catSchIDLUnsetGapsOn : unset gaps = catSchIDLUnsetGapsOff : don't unset gaps
iRouteSymbolUpdate: Whether to update route symbols' positions = catSchIDLSymbolUpdateOff : don't update route symbols = catSchIDLSymbolUpdateOn : update route symbols

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(x) As CATSafeArrayVariant

  ...
 objThisIntf.SetPath3dbVar1,CatSchIDLRouteCompressMode_Enum,CatSchIDLRouteUnsetGapsMode_Enum,CatSchIDLRouteSymbolUpdateMode_Enum

o Sub SetPath(		`iLDb2PtPath`,
		`iCompress`)

Set the defining points of a route graphic.

Parameters:

iLDbPtPath: A list of X-Y coordinates of the points to be set. 2 doubles per point.
iCompress: Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.) or not = SchCompressOn : compress = SchCompressOff : don't compress

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(x) As CATSafeArrayVariant

  ...
 objThisIntf.SetPathdbVar1,CatSchIDLRouteCompressMode_Enum

o Sub SetStartPoint( iDb2StartPt)

Set the start point of the route graphic.

Parameters:

iDb2StartPt: X-Y coordinates of the start point of the route graphic object to be set.

Example:

 Dim objThisIntf As SchGRRRoute
 Dim dbVar1(2) As CATSafeArrayVariant
  ...
 objThisIntf.SetStartPointdbVar1

SchGRRRoute (Object)

Method Index

Methods