thinkgeo.mapsuite.routing.routingtransactionbuffer
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.routingtransactionbuffer [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents the holding place for transactions that have not yet been committed. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer</a> | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingTransactionBuffer()|RoutingTransactionBuffer]] | | | This is the class constructor. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RoutingTransactionBuffer(Dictionary<String, RouteSegment>, Collection<String>, Dictionary<String, RouteSegment>)|RoutingTransactionBuffer]] | Dictionary<String, [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>, Collection<String>, Dictionary<String, [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | | This is the class constructor. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddRouteSegment(RouteSegment)|AddRouteSegment]] | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | | This method allows you to add RouteSegments to the transaction buffer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Clear()|Clear]] | | | This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DeleteRouteSegment(String)|DeleteRouteSegment]] | String | | This method allows you to add a placeholder to represent a RouteSegment to be deleted. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateFeature(RouteSegment)|UpdateFeature]] | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | | This method allows you to add a Feature to be updated. | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AddBuffer|AddBuffer]] | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | | This property gets the dictionary buffer that holds RouteSegments to be added. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DeleteBuffer|DeleteBuffer]] | Collection<String> | | This property gets the dictionary buffer that holds RouteSegments to be deleted. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#UpdateBuffer|UpdateBuffer]] | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> | | This property gets the dictionary buffer that holds RouteSegments to be updated. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== RoutingTransactionBuffer() ==== | ||
| - | This is the class constructor. | ||
| - | === Overloads === | ||
| - | This is the default constructor and is typically not used. | ||
| - | === Remarks === | ||
| - | This is the default constructor and is typically not used. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RoutingTransactionBuffer(Dictionary<String, RouteSegment>, Collection<String>, Dictionary<String, RouteSegment>) ==== | ||
| - | This is the class constructor. | ||
| - | === Overloads === | ||
| - | This is the constructor for this class allows you pass in the necessary properties in the class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | addBuffer | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Routing.RouteSegment} --> | | | ||
| - | | deleteBuffer | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | | ||
| - | | editBuffer | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Routing.RouteSegment} --> | | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#AddRouteSegment.28RouteSegment.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#AddRouteSegment.28RouteSegment.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | routeSegment | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]<!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | This parameter represents the RouteSegment you are adding to the transaction buffer. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | featureId | String<!-- System.String --> | This parameter represents the unique feature Id for the specific RouteSegment being passed in. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#UpdateFeature.28RouteSegment.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#UpdateFeature.28RouteSegment.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | routeSegment | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]<!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | This parameter represents the RouteSegment to be updated. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Routing.RouteSegment} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | Dictionary<String,[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Routing.RouteSegment} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RoutingTransactionBuffer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteRouting]] | ||
| - | [[Category:ThinkGeo.MapSuite.Routing]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.routing.routingtransactionbuffer.1440040134.txt.gz ยท Last modified: 2015/09/18 03:06 (external edit)
