thinkgeo.mapsuite.routing.rtgroutingsource
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.rtgroutingsource [2015/09/18 03:06] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Routing.RtgRoutingSource ====== | ||
| - | This class represents a RoutingSource based on an .rtg file. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.Routing.RoutingSource | ||
| - | ***ThinkGeo.MapSuite.Routing.RtgRoutingSource** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} RtgRoutingSource() ** | ||
| - | |||
| - | This is the class constructor. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RtgRoutingSource(String) ** | ||
| - | |||
| - | This is the class constructor. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:This parameter represents the path and file name of the .rtg file. This file stores routing source information. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GetRouteSegmentCount() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetRouteSegmentByFeatureId(String) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //featureId// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetRouteSegmentsNearestTo(BaseShape,FeatureSource,GeographyUnit,Int32) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //unitOfFeatureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //numberOfItemsToFind// | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} BeginTransaction() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} CommitTransaction() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.TransactionResult|TransactionResult]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RollbackTransaction() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AddRouteSegment(RouteSegment) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //routeSegment// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} UpdateRouteSegment(RouteSegment) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //routeSegment// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} DeleteRouteSegment(String) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //id// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,FeatureSource) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | This method is the overloads method. It will use do-not-rebuild mode and an empy string as adjunctiveInformation to call other methods. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:This parameter is the path and file name of the routing file you want to use. | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:This parameter is the feature source which gets enough information to generate routing data. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,FeatureSource,BuildRoutingDataMode) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | This method is the overloads method. It will use an empy string as adjunctiveInformation to call other methods. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:This parameter is the path and file name of the routing file you want to use. | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:This parameter is the feature source which gets enough information to generate routing data. | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:This parameter represents whether routing data will be rebuilt or not. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,FeatureSource,BuildRoutingDataMode,String) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:This parameter is the path and file name of the routing file you want to use. | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:This parameter is the feature source which gets enough information to generate routing data. | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:This parameter represents whether routing data will be rebuilt or not. | ||
| - | |||
| - | * //adjunctiveInformation// | ||
| - | * Type:String | ||
| - | * Description:This parameter represents the adjunctive information which will be stored in the .rtg file. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,FeatureSource,BuildRoutingDataMode,GeographyUnit,DistanceUnit) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //geographyUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //distanceUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,String,BuildRoutingDataMode) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //sourceShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //routableShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,String,String,BuildRoutingDataMode) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //sourceShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //routableShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutingData(String,String,String,BuildRoutingDataMode,GeographyUnit,DistanceUnit) ** | ||
| - | |||
| - | This method generates routing data to an .rtg file based on a feature source. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //rtgFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //sourceShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //routableShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //buildRoutingDataMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildRoutingDataMode|BuildRoutingDataMode]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //geographyUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //distanceUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateRoutableShapeFile(String,String,OverwriteMode) ** | ||
| - | |||
| - | Create the routable shapefile which can be used to create RTG file directly. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //shapefilePathName// | ||
| - | * Type:String | ||
| - | * Description:The path name of the source shape file. | ||
| - | |||
| - | * //routableShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:The path name of the routable shape file created. | ||
| - | |||
| - | * //overwriteMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.OverwriteMode|OverwriteMode]] | ||
| - | * Description:The write mode used to specify whether we should overwrite the existed file. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetRouteSegmentByFeatureIdCore(String) ** | ||
| - | |||
| - | This method returns a RouteSegment by providing its ID in the RoutingSource. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | ||
| - | * Description:The RouteSegment based on a specific ID. | ||
| - | |||
| - | == Parameters == | ||
| - | * //featureId// | ||
| - | * Type:String | ||
| - | * Description:This parameter is the feature ID which uniquely identifies it in the RoutingSource. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | |||
| - | This method opens the RoutingSource so that it is initialized and ready to use. | ||
| - | == Remarks == | ||
| - | This protected method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the RoutingSource. Most methods on the RoutingSource will throw an exception if the state of the RoutingSource is not opened. When the map draws each layer, it will open the RoutingSource as one of its first steps, then after it is finished drawing with that layer it will close it. In this way we are sure to release all resources used by the RoutingSource. This implementation of OpenCore opens the .rtg file and .rtx file. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | |||
| - | This method allows you to raise the StreamLoading event. | ||
| - | == Remarks == | ||
| - | This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes, so we exposed a way to raise the event as necessary through this protected method. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | * Description:This parameter represents the event arguments you want to raise the StreamLoading event with. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | |||
| - | This method closes the RoutingSource and releases any resources it was using. | ||
| - | == Remarks == | ||
| - | This method is the concrete wrapper for the abstract method CloseCore. The Close method plays an important role in the life cycle of the RoutingSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override the Core version of this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed RoutingSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. This implementation of CloseCore closes the .rtg file and .rtx file. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} BeginTransactionCore() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CommitTransactionCore(RoutingTransactionBuffer) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.TransactionResult|TransactionResult]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //transactionBuffer// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer|RoutingTransactionBuffer]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} RollbackTransactionCore() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetRouteSegmentCountCore() ** | ||
| - | |||
| - | This method returns the count of the number of records in this RoutingSource. | ||
| - | == Remarks == | ||
| - | This protected method is called from the concrete public method GetCount. It does not take into account any transaction activity, as this is the responsibility of the concrete public method GetRouteSegmentCount. This way, as a developer, if you choose to override this method you do not have to consider transactions at all. The implementation of GetRouteSegmentCountCore returns the count from the .rtg file. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:This method returns the count of the number of records in this RoutingSource. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetRouteSegmentsNearestToCore(BaseShape,FeatureSource,GeographyUnit,Int32) ** | ||
| - | |||
| - | This method returns a user defined number of Route Segments that are closest to the TargetShape. | ||
| - | == Remarks == | ||
| - | This method returns a user defined number of Route Segments that are closest to the TargetShape, and it is called in the GetRouteSegmentsNearestTo method, you need to implement it if you define a custome RoutingSource.It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | ||
| - | * Description:This method returns a user defined number of Route Segments that are closest to the TargetShape. | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:This parameter is the shape you want to find Route Segments close to. | ||
| - | |||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| - | * Description:This parameter defines the FeatureSource that is used to get information of RouteSegments | ||
| - | |||
| - | * //unitOfFeatureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | * Description:This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| - | |||
| - | * //numberOfItemsToFind// | ||
| - | * Type:Int32 | ||
| - | * Description:This parameter defines how many close Route Segments to find around the TargetShape. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnCommittingTransaction(RoutingCommittingTransactionEventArgs) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingCommittingTransactionEventArgs|RoutingCommittingTransactionEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnCommittedTransaction(RoutingCommittedTransactionEventArgs) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingCommittedTransactionEventArgs|RoutingCommittedTransactionEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} OnBuildingRoutingData(BuildingRoutingDataRtgRoutingSourceEventArgs) ** | ||
| - | |||
| - | This method allows you to raise the BuildingRoutingData event from a derived class. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //args// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.BuildingRoutingDataRtgRoutingSourceEventArgs|BuildingRoutingDataRtgRoutingSourceEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} OnGeneratingRoutableShapefile(GeneratingRoutableShapeFileRoutingSourceEventArgs) ** | ||
| - | |||
| - | This method allows you to raise the GeneratingRoutableShapeFile event from a derived class. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //args// | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.GeneratingRoutableShapeFileRoutingSourceEventArgs|GeneratingRoutableShapeFileRoutingSourceEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} vhQ=(ShapeFileFeatureSource,String,OverwriteMode) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //featureSource// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ShapeFileFeatureSource|ShapeFileFeatureSource]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //routableShapeFilePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //overwriteMode// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.OverwriteMode|OverwriteMode]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} RtgFilePathName ** | ||
| - | |||
| - | This property returns the path and file name of the routing file you want to use. | ||
| - | == Remarks == | ||
| - | When you specify the path and file name it should be in the correct format as such; however, the file does not need to actually exist on the file system. This allows us to accept streams supplied by the developer at runtime. If you choose to provide a file that exists then we will attempt to use it. If we cannot find the file then we will raise the SteamLoading event and allow you to supply the stream. For example, you can pass in "C:\NotARealPath\File1.rtg" which does not exist on the file system. When we raise the event for you to supply a stream, we will pass to you the path and file name so that you can differentiate the files. | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ReadEndPoints ** | ||
| - | |||
| - | Gets or sets a value indicating whether re | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CachedIndex ** | ||
| - | |||
| - | Gets or sets a value indicating whether we should cache the index records to improve the performance. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} GeographyUnit ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AdjunctiveInformation ** | ||
| - | |||
| - | Gets a value that represents the adjunctive information. | ||
| - | == Remarks == | ||
| - | When you build the routing data by calling GenerateRoutingData, you can pass in the adjunctive information. For example, you can store the company or project version information in it. | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsEditable ** | ||
| - | |||
| - | This property returns whether the RoutingSource allows edits or is read-only. | ||
| - | == Remarks == | ||
| - | This property is useful to check if a specific RoutingSource accepts editing. If you call BeginTransaction and this property is false, then an exception will be raised. For developers who are creating or extending a RoutingSource, it is expected that you override this virtual method if the new RoutingSource you are creating allows edits. | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Version ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsInTransaction ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} kRQ= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer|RoutingTransactionBuffer]] | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} BuildingRoutingData ** | ||
| - | This event is called during building of routing data. | ||
| - | == Remarks == | ||
| - | This event is called during building of routing data. It will be called many times during the build. | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Routing.BuildingRoutingDataRtgRoutingSourceEventArgs|BuildingRoutingDataRtgRoutingSourceEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} GeneratingRoutableShapeFile ** | ||
| - | This event is called during generating the routable shapefile from raw files. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Routing.GeneratingRoutableShapeFileRoutingSourceEventArgs|GeneratingRoutableShapeFileRoutingSourceEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ||
| - | This event allows you to pass in your own stream to represent the Routing Index file. | ||
| - | == Remarks == | ||
| - | If you wish, you can pass in your own stream to represent the Routing Index file. The stream can come from a variety of places, including isolated storage, a compressed file, or an encrypted stream. When the file is finished with the stream it will dispose of it, so be sure to keep this in mind when passing the stream in. If you do not pass in an alternate stream, the class will attempt to load the file from the file system using the PathFileName property. | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} CommittingTransaction ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Routing.RoutingCommittingTransactionEventArgs|RoutingCommittingTransactionEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} CommittedTransaction ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Routing.RoutingCommittedTransactionEventArgs|RoutingCommittedTransactionEventArgs]] | ||
| - | |||
thinkgeo.mapsuite.routing.rtgroutingsource.1442545611.txt.gz ยท Last modified: 2015/09/18 03:06 by admin
