All Frameworks  Object Hierarchy  This Framework  Indexes

SchRoute (Object)

Manage a schematic route data.

AddPoints: Add a list of point to a route.
Branch: Create a branch from this route.
Break: Break a route into 2 pieces.
Compress: Compress a the defining points of a route, removing coincident points.
ConcatenateKeepRoute2: Concatenate 2 routes into one.
Concatenate: Concatenate 2 routes into one.
GetExtremityCntrs: Get extremity connectors of the route.
GetPath: Get the defining points of a route.
OKToBranch: Query whether it is OK to create a branch.
OKToBreak: Query whether it is OK to break.
OKToConcatenate: Query whether it is OK to concatenate.
OKToModifyPoints: Query whether it is OK to modify (add or remove) the points.
RemovePoints: Remove points from route.
ReshapeExtremity2: Change the position of the extremity of the route.
ReshapeExtremity: Change the position of the extremity of the route.
SetPath: Set the defining points of a route.

Methods

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

Add a list of point to a route. Modify the route according to the route mode

Parameters:

iGRR: graphical primitive of the route to add points to (if NULL, assume there is only one graphical primitive)
iLDbPtPathToAdd: A list of X-Y coordinates of 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 SchRoute
 Dim objArg1 As SchGRRRoute
 Dim dbVar2(x) As CATSafeArrayVariant
 Dim intVar4 As Integer
  ...
 objThisIntf.AddPointsobjArg1,dbVar2,intVar4

o Sub Branch(		`iGRRMain`,
		`iSchBranchRoute`,
		`iSchBranchRouteCntr`,
		`oBranchCntn`,
		`oNewBranchCntr`)

Create a branch from this route.

Parameters:

iGRRMain: graphical primitive of the "this" route to branch from (if NULL, assume there is only one graphical primitive)
iSchBranchRoute: The route to create a branch connection to (from this route)
iSchBranchRouteCntr: The extremity connector of the branch
oBranchCntn: The branch connection created
oNewBranchCntr: The new branch connector created on "this" route

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim objArg2 As SchRoute
 Dim objArg3 As SchAppConnector
 Dim objArg4 As SchAppConnection
 Dim objArg5 As SchAppConnector
  ...
 objThisIntf.BranchobjArg1,objArg2,objArg3,objArg4,objArg5

o Sub Break(		`iGRR`,
		`iDb2Pt1`,
		`iDb2Pt2`,
		`oNewSchRoute`)

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

Parameters:

iGRR: graphical primitive of the route to be broken (if NULL, assume there is only one graphical primitive)
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 (sends in a NULL). point 1 and point 2 are the same.
oNewSchRoute: The new Schematic route object

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim dbVar2(2) As CATSafeArrayVariant
 Dim dbVar3(2) As CATSafeArrayVariant
 Dim objArg4 As SchRoute
  ...
 objThisIntf.BreakobjArg1,dbVar2,dbVar3,objArg4

o Sub Compress(

)

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

Example:

 Dim objThisIntf As SchRoute
  ...
 objThisIntf.Compress

o Sub ConcatenateKeepRoute2(		`iSchRoute1Cntr`,
		`iSchRoute2`,
		`iSchRoute2Cntr`)

Concatenate 2 routes into one. Only works for those that have only one line graphic object. The first route is elongated and is modified. The second route is unchanged.

Parameters:

iSchRoute1Cntr: Connector of this route to concatenate with the second route.
iSchRoute2: Second route to be concatenate to the first. iSchRoute2 will be unchanged.
iSchRoute2Cntr: Connector of second route to concatenate with the first route.

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchAppConnector
 Dim objArg2 As SchRoute
 Dim objArg3 As SchAppConnector
  ...
 objThisIntf.ConcatenateKeepRoute2objArg1,objArg2,objArg3

o Sub Concatenate(		`iSchRoute1Cntr`,
		`iSchRoute2`,
		`iSchRoute2Cntr`)

Concatenate 2 routes into one. Only works for those that have only one line graphic object. The first route is elongated and is modified. The second route is deleted.

Parameters:

iSchRoute1Cntr: Connector of this route to concatenate with the second route.
iSchRoute2: Second route to be concatenate to the first. iSchRoute2 will be deleted.
iSchRoute2Cntr: Connector of second route to concatenate with the first route.

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchAppConnector
 Dim objArg2 As SchRoute
 Dim objArg3 As SchAppConnector
  ...
 objThisIntf.ConcatenateobjArg1,objArg2,objArg3

o Sub GetExtremityCntrs(		`iGRR`,
		`oRouteCntr1`,
		`oRouteCntr2`)

Get extremity connectors of the route.

Parameters:

iGRR: graphical primitive of the route to query. (if NULL, assume there is only one graphical primitive)
oRouteCntr1: Route connector at first extremity
oRouteCntr2: Route connector at second extremity

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim objArg2 As SchAppConnector
 Dim objArg3 As SchAppConnector
  ...
 objThisIntf.GetExtremityCntrsobjArg1,objArg2,objArg3

o Sub GetPath(		`iGRR`,
		`oLDb2PtPath`)

Get the defining points of a route.

Parameters:

iGRR: graphical primitive of the route get the path from (if NULL, assume there is only one graphical primitive)
oLDbPtPath: A list of X-Y coordinates of points. 2 doubles per point.

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim objArg2 As SchListOfDoubles
  ...
 objThisIntf.GetPathobjArg1,objArg2

o Sub OKToBranch(		`iGRR`,
		`iBranchClassType`,
		`oBYes`)

Query whether it is OK to create a branch.

Parameters:

iGRR: graphical primitive of the route to query. (if NULL, assume there is only one graphical primitive)
iBranchClassType: Class type of the branch to create.
oBYes: If TRUE, then it is OK to create a branch from a route

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim strVar2 As String
 Dim bVar3 As boolean
  ...
 objThisIntf.OKToBranchobjArg1,strVar2,bVar3

o Sub OKToBreak(		`iGRR`,
		`oBYes`)

Query whether it is OK to break.

Parameters:

iGRR: graphical primitive of the route to query. (if NULL, assume there is only one graphical primitive)
oBYes: If TRUE, then it is OK to break the route

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToBreakobjArg1,bVar2

o Sub OKToConcatenate(		`iGRR`,
		`oBYes`)

Query whether it is OK to concatenate.

Parameters:

iGRR: graphical primitive of the route to query. (if NULL, assume there is only one graphical primitive)
oBYes: If TRUE, then it is OK to concatenate the route with another

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToConcatenateobjArg1,bVar2

o Sub OKToModifyPoints(		`iGRR`,
		`oBYes`)

Query whether it is OK to modify (add or remove) the points.

Parameters:

iGRR: graphical primitive of the route to query. (if NULL, assume there is only one graphical primitive).
oBYes: If TRUE, then it is OK to add or remove the points from the route

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToModifyPointsobjArg1,bVar2

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

Remove points from route. Modify the route according to the route mode.

Parameters:

iGRR: graphical primitive of the route to remove the points from (if NULL, assume there is only one graphical primitive)
iNumOfPtsToRemove: The number of points to be removed
iAfterWhichPtNum: The point number at which to start removing the point.

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim intVar2 As Integer
 Dim intVar3 As Integer
  ...
 objThisIntf.RemovePointsobjArg1,intVar2,intVar3

o Sub ReshapeExtremity2(		`iERouteMode`,
		`iGRR`,
		`iRouteCntr`,
		`iDb2PtToMoveCntrTo`)

Change the position of the extremity of the route. Modify the route according to the route mode.

Parameters:

iERouteMode: Routing mode.
iGRR: graphical primitive of the route to reshape (if NULL, assume there is only one graphical primitive)
iRouteCntr: Route connector whose position is to be modified (CATISchConnector interface pointer).
iDb2PtToMoveCntrTo: X-Y coordinates of the point to move the connector to.

Example:

 Dim objThisIntf As SchRoute

 Dim objArg2 As SchGRRRoute
 Dim objArg3 As SchAppConnector
 Dim dbVar4(2) As CATSafeArrayVariant
  ...
 objThisIntf.ReshapeExtremity2CatSchIDLRouteMode_Enum,objArg2,objArg3,dbVar4

o Sub ReshapeExtremity(		`iGRR`,
		`iRouteCntr`,
		`iDb2DeltaXY`)

Change the position of the extremity of the route.

Parameters:

iGRR: graphical primitive of the route to reshape (if NULL, assume there is only one graphical primitive)
iRouteCntr: Route connector whose position is to be modified (CATISchAppConnector interface pointer).
iDb2DeltaXY: Delta X-Y coordinates of the extremity move

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim objArg2 As SchAppConnector
 Dim dbVar3(2) As CATSafeArrayVariant
  ...
 objThisIntf.ReshapeExtremityobjArg1,objArg2,dbVar3

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

Set the defining points of a route.

Parameters:

iGRR: graphical primitive of the route to set the path on (if NULL, assume there is only one graphical primitive)
iLDbPtPath: A list of X-Y coordinates of points to be set. 2 doubles per point.

Example:

 Dim objThisIntf As SchRoute
 Dim objArg1 As SchGRRRoute
 Dim dbVar2(x) As CATSafeArrayVariant
  ...
 objThisIntf.SetPathobjArg1,dbVar2

SchRoute (Object)

Method Index

Methods