Table of Contents
ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
This class represents the holding place for transactions that have not yet been committed.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer
Members Summary
Public Constructors
RoutingTransactionBuffer()
- This is the class constructor.
Remarks
- This is the default constructor and is typically not used.
Parameters
RoutingTransactionBuffer(Dictionary<String,RouteSegment>,Collection<String>,Dictionary<String,RouteSegment>)
- N/A
Remarks
- N/A
Parameters
- addBuffer
- Type:Dictionary<String,RouteSegment>
- Description:N/A
- deleteBuffer
- Type:Collection<String>
- Description:N/A
- editBuffer
- Type:Dictionary<String,RouteSegment>
- Description:N/A
Protected Constructors
Public Methods
Clear()
- This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer.
Remarks
- This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer.
Return Value
- Type:Void
- Description:N/A
Parameters
AddRouteSegment(RouteSegment)
- This method allows you to add RouteSegments to the transaction buffer.
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#AddRouteSegment.28RouteSegment.29
Return Value
- Type:Void
- Description:N/A
Parameters
- routeSegment
- Type:RouteSegment
- Description:This parameter represents the RouteSegment you are adding to the transaction buffer.
DeleteRouteSegment(String)
- This method allows you to add a placeholder to represent a RouteSegment to be deleted.
Remarks
- This does not remove a RouteSegment from the TransactionBuffer but rather it add a “to be deleted record”. In this way when the TransactionBuffer if processed we know what records need to be deleted.
Return Value
- Type:Void
- Description:N/A
Parameters
- featureId
- Type:String
- Description:This parameter represents the unique feature Id for the specific RouteSegment being passed in.
UpdateFeature(RouteSegment)
- This method allows you to add a Feature to be updated.
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#UpdateFeature.28RouteSegment.29
Return Value
- Type:Void
- Description:N/A
Parameters
- routeSegment
- Type:RouteSegment
- Description:This parameter represents the RouteSegment to be updated.
ToString()
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#ToString.28.29
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Equals.28Object.29
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetHashCode.28.29
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetType.28.29
Return Value
- Type:Type
- Description:N/A
Parameters
Protected Methods
Finalize()
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Finalize.28.29
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#MemberwiseClone.28.29
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
AddBuffer
This property gets the dictionary buffer that holds RouteSegments to be added.
Remarks
It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteRouteSegment twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.
Return Value
- Type:Dictionary<String,RouteSegment>
DeleteBuffer
This property gets the dictionary buffer that holds RouteSegments to be deleted.
Remarks
It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteRouteSegment twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.
Return Value
- Type:Collection<String>
UpdateBuffer
This property gets the dictionary buffer that holds RouteSegments to be updated.
Remarks
It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteRouteSegment twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.
Return Value
- Type:Dictionary<String,RouteSegment>