All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Interface CATISchGRRRoute
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchGRRRoute
Interface to manage a Schematic route graphic object.
Role: Defines Schematic route graphic object content.
Method Index
- o
AddPoints(double*,int,int)
- Add a list of point to a route.
- o
Break(double[2],double*,CATISchGRRRoute**)
- Break a route graphic into 2 pieces.
- o
Compress2(CATSchRouteUnsetGapsMode)
- Compress the defining points of a route graphic, removing coincident points.
- o
Compress()
- Compress a the defining points of a route graphic, removing coincident points.
- o
ConcatenateKeepGRR2(int,CATISchGRRRoute*,int)
- Concatenate 2 route graphic objects into one.
- o
Concatenate(int,CATISchGRRRoute*,int)
- Concatenate 2 route graphic objects into one.
- o
CreateRouteSymbol(int&,double&,CATISchGRR*,CATISchRouteSymbol**)
- Place a symbol on the route.
- o
GetEndPoint(double*)
- Get the end point of the route graphic.
- o
GetPath(double**,int*)
- Get the defining points of a route graphic.
- o
GetStartPoint(double*)
- Get the start point of the route graphic.
- o
ListRouteSymbols(CATIUnknownList**)
- List route symbols on the route.
- o
RemovePoints(int,int)
- Remove points from route graphic.
- o
SetEndPoint(double[2])
- Set the end point of the route graphic.
- o
SetPath2(double*,int,CATSchRouteCompressMode,CATSchRouteUnsetGapsMode)
- Set the defining points of a route graphic.
- o
SetPath3(double*,int,CATSchRouteCompressMode,CATSchRouteUnsetGapsMode,CATSchRouteSymbolUpdateMode)
- Set the defining points of a route graphic.
- o
SetPath(double*,int,CATSchRouteCompressMode)
- Set the defining points of a route graphic.
- o
SetStartPoint(double[2])
- Set the start point of the route graphic.
Methods
o AddPoints
| public virtual AddPoints( | | iLDb2PtPathToAdd, |
| const | iSizeOfPath, |
| const | 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.
- 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 Break
| public virtual Break( | const | 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)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Compress2
| public virtual Compress2( | | iUnsetGaps | = SchUnsetGapsOn) |
-
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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Compress
| public virtual Compress( | ) |
-
Compress a the defining points of a route graphic, removing coincident points.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ConcatenateKeepGRR2
| public virtual ConcatenateKeepGRR2( | const | iWhichEnd1, |
| | iGRRRoute2, |
| const | 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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Concatenate
| public virtual Concatenate( | const | iWhichEnd1, |
| | iGRRRoute2, |
| const | 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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateRouteSymbol
| public virtual CreateRouteSymbol( | const | iSegNum, |
| const | iSegParm, |
| const | 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).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetEndPoint
| public virtual GetEndPoint( | | oDb2EndPt) |
-
Get the end point of the route graphic.
- Parameters:
-
- oDb2EndPt
- X-Y coordinates of the end point of the route graphic object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetPath
| public virtual GetPath( | | oLDb2PtPath, |
| | oSizeOfPath) |
-
Get the defining points of a route graphic.
- Parameters:
-
- oLDbPtPath
- A list of X-Y coordinates of the 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 GetStartPoint
| public virtual GetStartPoint( | | oDb2StartPt) |
-
Get the start point of the route graphic.
- Parameters:
-
- oDb2StartPt
- X-Y coordinates of the start point of the route graphic object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListRouteSymbols
| public virtual ListRouteSymbols( | | oLRouteSymbol) |
-
List route symbols on the route.
- Parameters:
-
- oLRouteSymbol
- A list of route symbols.
(members are CATISchRouteSymbol interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemovePoints
| public virtual RemovePoints( | const | iNumOfPtsToRemove, |
| const | 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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetEndPoint
| public virtual SetEndPoint( | const | 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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPath2
| public virtual SetPath2( | | iLDb2PtPath, |
| const | iSizeOfPath, |
| | iCompress | = SchCompressOn, |
| | iUnsetGaps | = SchUnsetGapsOn) |
-
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.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- 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
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPath3
| public virtual SetPath3( | | iLDb2PtPath, |
| const | iSizeOfPath, |
| | iCompress | = SchCompressOn, |
| | iUnsetGaps | = SchUnsetGapsOn, |
| | iRouteUpdateSymbols | = SchSymbolUpdateOn) |
-
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.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- 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
- iRouteSymbolUpdate
- Whether to update route symbols' positions
= SchSymbolUpdateOff : don't update route symbols
= SchSymbolUpdateOn : update route symbols
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPath
| public virtual SetPath( | | iLDb2PtPath, |
| const | iSizeOfPath, |
| | iCompress | = SchCompressOn) |
-
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.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- iCompress
- Whether to compress the route (i.e., remove duplicate pts, colinear
segments, etc.) or not
= SchCompressOn : compress
= SchCompressOff : don't compress
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetStartPoint
| public virtual SetStartPoint( | const | 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.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchGRRRoute.h