All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchRoute
System.IUnknown
|
+---CATISchRoute
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchRoute
Interface to manage a Schematic route object.
Role: Defines Schematic route object behaviors
Method Index
- o
AddPoints(CATISchGRRRoute*,double*,int,int)
- Add a list of point to a route.
- o
Branch(CATISchGRRRoute*,CATISchRoute*,CATISchAppConnector*,CATISchAppConnection**,CATISchAppConnector**)
- Create a branch from this route.
- o
Break(CATISchGRRRoute*,double[2],double*,CATISchRoute**)
- Break a route into 2 pieces.
- o
Compress()
- Compress a the defining points of a route, removing coincident points.
- o
Concatenate(CATISchAppConnector*,CATISchRoute*,CATISchAppConnector*)
- Concatenate 2 routes into one.
- o
ConcatenateKeepRoute2(CATISchAppConnector*,CATISchRoute*,CATISchAppConnector*)
- Concatenate 2 routes into one.
- o
GetExtremityCntrs(CATISchGRRRoute*,CATISchAppConnector**,CATISchAppConnector**)
- Get extremity connectors of the route.
- o
GetPath(CATISchGRRRoute*,double**,int*)
- Get the defining points of a route.
- o
OKToBranch(CATISchGRRRoute*,char*,CATBoolean*)
- Query whether it is OK to create a branch.
- o
OKToBreak(CATISchGRRRoute*,CATBoolean*)
- Query whether it is OK to break.
- o
OKToConcatenate(CATISchGRRRoute*,CATBoolean*)
- Query whether it is OK to concatenate.
- o
OKToModifyPoints(CATISchGRRRoute*,CATBoolean*)
- Query whether it is OK to modify (add or remove) the points.
- o
RemovePoints(CATISchGRRRoute*,int,int)
- Remove points from route.
- o
ReshapeExtremity(CATISchGRRRoute*,CATISchAppConnector*,double[2])
- Change the position of the extremity of the route.
- o
ReshapeExtremity(CATSchRouteMode,CATISchGRRRoute*,CATISchAppConnector*,double[2])
- Change the position of the extremity of the route.
- o
SetPath(CATISchGRRRoute*,double*,int)
- Set the defining points of a route.
Methods
o AddPoints
public virtual HRESULT AddPoints( | CATISchGRRRoute* | iGRR, |
| double* | iLDb2PtPathToAdd, |
| const int | iSizeOfPath, |
| const int | iAfterWhichPtNum) = 0 |
-
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.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- iAfterWhichPtNum
- The point number to add the points after. Use 0 to indicate adding
before the first point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Branch
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Break
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Compress
public virtual HRESULT Compress( | )= 0 |
-
Compress a the defining points of a route, removing coincident points.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Concatenate
-
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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ConcatenateKeepRoute2
-
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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetExtremityCntrs
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetPath
-
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.
- oSizeOfPath
- Total number of points in the list. 2 times the number of points.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToBranch
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToBreak
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToConcatenate
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToModifyPoints
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemovePoints
public virtual HRESULT RemovePoints( | CATISchGRRRoute* | iGRR, |
| const int | iNumOfPtsToRemove, |
| const int | iAfterWhichPtNum) = 0 |
-
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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ReshapeExtremity
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ReshapeExtremity
-
Change the position of the extremity of the route.
Modify the route according to the route mode.
- Parameters:
-
- iERouteMode
- Routing mode.
- See also:
- CATSchRouteMode
- 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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPath
-
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.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchRoute.h