This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.featurecache [2015/09/17 10:28] admin |
thinkgeo.mapsuite.core.featurecache [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.FeatureCache ====== | ====== ThinkGeo.MapSuite.Core.FeatureCache ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
FeatureCache is a cache system used in FeatureSource to speed up the fetching data system. | FeatureCache is a cache system used in FeatureSource to speed up the fetching data system. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 5: | Line 8: | ||
***ThinkGeo.MapSuite.Core.FeatureCache** | ***ThinkGeo.MapSuite.Core.FeatureCache** | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} FeatureCache() ** |
- | **{{wiki:PublicMethod.gif|}}[[#FeatureCache()|FeatureCache]]** | + | |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This is the default constructor that will create a new instance of the FeatureCache. | + | |
- | </div> | + | |
- | === Protected Constructors === | + | * //This is the default constructor that will create a new instance of the FeatureCache.// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //The cache system is not used by default. If you want to use it, you must set the IsActive property to true.// |
- | **{{wiki:PublicMethod.gif|}}[[#Add(RectangleShape,Collection<Feature>)|Add]]** | + | == Parameters == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | <div newline></div> |
- | * **DeclaringType**:N/A | + | ==== Protected Constructors ==== |
- | * **Summary**:This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features. | + | ==== Public Methods ==== |
- | </div> | + | ** {{wiki:PublicMethod.gif|}} GetFeatures(RectangleShape) ** |
- | <div class_table> | + | * //This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation.// |
- | **{{wiki:PublicMethod.gif|}}[[#Clear()|Clear]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //This method is the concrete wrapper for the virtual method GetFeaturesCore. It will return whatever is returned by the GetBoundingBoxCore method. To determine what the default implementation of the abstract GetBoundingBoxCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method clears all of the CachedItems in this FeatureCache. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#Close()|Close]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | * **Parameters**:N/A | + | * Description:This method returns a Collection of Features cached in the FeatureCache system. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:The default implementation is to do nothing. | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | * //worldExtent// |
- | * **Parameters**:Object | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:Object | + | * Description:N/A |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#GetFeatures(RectangleShape)|GetFeatures]]** | + | ** {{wiki:PublicMethod.gif|}} Clear() ** |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method clears all of the CachedItems in this FeatureCache.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Void |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#IsExtentCached(RectangleShape)|IsExtentCached]]** | + | <div newline></div> |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} Add(RectangleShape,Collection<Feature>) ** |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method determines whether the WorldExtent is already cached in the FeatureCache System. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features.// |
- | **{{wiki:PublicMethod.gif|}}[[#Open()|Open]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //This method is the concrete wrapper for the virtual method AddCore. It will return whatever is returned by the AddCore method. To determine what the default implementation of the abstract AddCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:The default implementation is to do nothing. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:Void |
- | * **Parameters**:N/A | + | * Description:None. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | == Parameters == |
- | <div class_table> | + | * //worldExtent// |
- | **{{wiki:ProtectedMethod.gif|}}[[#AddCore(RectangleShape,Collection<Feature>)|AddCore]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Description:N/A |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features. | + | |
- | </div> | + | |
- | <div class_table> | + | * //features// |
- | **{{wiki:ProtectedMethod.gif|}}[[#CloseCore()|CloseCore]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:The default implementation is to do nothing. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //The default implementation is to do nothing.// |
- | **{{wiki:ProtectedMethod.gif|}}[[#GetFeaturesCore(RectangleShape)|GetFeaturesCore]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //This method is the concrete wrapper for the virtual method OpenCore. It will return whatever is returned by the OpenCore method. To determine what the default implementation of the abstract OpenCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:Void |
- | * **Parameters**:N/A | + | * Description:None. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:ProtectedMethod.gif|}}[[#OpenCore()|OpenCore]]** | + | <div newline></div> |
- | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:The default implementation is to do nothing. | + | |
- | </div> | + | |
- | === Public Properties === | + | * //The default implementation is to do nothing.// |
- | **{{wiki:PublicProperty.gif|}}[[#IsActive|IsActive]]** | + | == Remarks == |
- | * **Return**:Boolean | + | * //This method is the concrete wrapper for the virtual method CloseCore. It will return whatever is returned by the CloseCore method. To determine what the default implementation of the abstract CloseCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | * **Summary**:This boolean property sepcifies whether cache system is active or not. | + | |
- | === Protected Properties === | + | == Return Value == |
- | === Public Events === | + | * Type:Void |
- | ===== Public Constructors ===== | + | * Description:None. |
- | === FeatureCache() === | + | |
- | This is the default constructor that will create a new instance of the FeatureCache. | + | |
- | ==== Remarks ==== | + | |
- | The cache system is not used by default. If you want to use it, you must set the IsActive property to true. | + | |
- | ==== Parameters ==== | + | |
- | [[#Public Constructors|Go Back]] | + | |
- | ===== Protected Constructors ===== | + | |
- | ===== Public Methods ===== | + | |
- | === Add(RectangleShape,Collection<Feature>) === | + | |
- | This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features. | + | |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method AddCore. It will return whatever is returned by the AddCore method. To determine what the default implementation of the abstract AddCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | <div newline></div> |
- | * **Description**:None. | + | ** {{wiki:PublicMethod.gif|}} IsExtentCached(RectangleShape) ** |
- | ==== Parameters ==== | + | * //This method determines whether the WorldExtent is already cached in the FeatureCache System.// |
- | **worldExtent** | + | == Remarks == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **Description**:N/A | + | |
- | **features** | + | == Return Value == |
- | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Type:Boolean |
- | * **Description**:N/A | + | * Description:True if the specified WorldExtent is already cached. Otherwise, returns false. |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === Clear() === | + | * //worldExtent// |
- | This method clears all of the CachedItems in this FeatureCache. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | ==== Remarks ==== | + | * Description:The target WorldExtent which will be determined as already cached or not. |
- | N/A | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:Void | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | * **Description**:N/A | + | |
- | ==== Parameters ==== | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | === Close() === | + | * //N/A// |
- | The default implementation is to do nothing. | + | |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method CloseCore. It will return whatever is returned by the CloseCore method. To determine what the default implementation of the abstract CloseCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Void | + | * Type:String |
- | * **Description**:None. | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === Equals(Object) === | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Boolean | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **obj** | + | * Type:Boolean |
- | * **Type**:Object | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetFeatures(RectangleShape) === | + | * //obj// |
- | This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation. | + | * Type:Object |
- | ==== Remarks ==== | + | * Description:N/A |
- | This method is the concrete wrapper for the virtual method GetFeaturesCore. It will return whatever is returned by the GetBoundingBoxCore method. To determine what the default implementation of the abstract GetBoundingBoxCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Description**:This method returns a Collection of Features cached in the FeatureCache system. | + | |
- | ==== Parameters ==== | + | * //N/A// |
- | **worldExtent** | + | == Remarks == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === GetHashCode() === | + | * Type:Int32 |
- | N/A | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Int32 | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | === GetType() === | + | * //N/A// |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Type | + | * Type:Type |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === IsExtentCached(RectangleShape) === | + | ==== Protected Methods ==== |
- | This method determines whether the WorldExtent is already cached in the FeatureCache System. | + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesCore(RectangleShape) ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation.// |
- | * **Return Type**:Boolean | + | == Remarks == |
- | * **Description**:True if the specified WorldExtent is already cached. Otherwise, returns false. | + | * //This method is the concrete wrapper for the virtual method GetFeaturesCore. It will return whatever is returned by the GetBoundingBoxCore method. To determine what the default implementation of the abstract GetBoundingBoxCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | ==== Parameters ==== | + | == Return Value == |
- | **worldExtent** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This method returns a Collection of Features cached in the FeatureCache system. |
- | * **Description**:The target WorldExtent which will be determined as already cached or not. | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === Open() === | + | * //worldExtent// |
- | The default implementation is to do nothing. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | ==== Remarks ==== | + | * Description:N/A |
- | This method is the concrete wrapper for the virtual method OpenCore. It will return whatever is returned by the OpenCore method. To determine what the default implementation of the abstract OpenCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:Void | + | ** {{wiki:ProtectedMethod.gif|}} AddCore(RectangleShape,Collection<Feature>) ** |
- | * **Description**:None. | + | |
- | ==== Parameters ==== | + | * //This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features.// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | === ToString() === | + | * //This method is the concrete wrapper for the virtual method AddCore. It will return whatever is returned by the AddCore method. To determine what the default implementation of the abstract AddCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:String | + | * Type:Void |
- | * **Description**:N/A | + | * Description:None. |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //worldExtent// |
- | ===== Protected Methods ===== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | === AddCore(RectangleShape,Collection<Feature>) === | + | * Description:N/A |
- | This method will add an item to the FeatureCache system by passing a WorldExtent as "Key" and a collection of features as its corresponding cached features. | + | |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method AddCore. It will return whatever is returned by the AddCore method. To determine what the default implementation of the abstract AddCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | * //features// |
- | * **Return Type**:Void | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | * **Description**:None. | + | * Description:N/A |
- | ==== Parameters ==== | + | <div newline></div> |
- | **worldExtent** | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
- | * **Description**:N/A | + | |
- | **features** | + | * //The default implementation is to do nothing.// |
- | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | == Remarks == |
- | * **Description**:N/A | + | * //This method is the concrete wrapper for the virtual method OpenCore. It will return whatever is returned by the OpenCore method. To determine what the default implementation of the abstract OpenCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | [[#Protected Methods|Go Back]] | + | == Return Value == |
- | === CloseCore() === | + | * Type:Void |
- | The default implementation is to do nothing. | + | * Description:None. |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method CloseCore. It will return whatever is returned by the CloseCore method. To determine what the default implementation of the abstract CloseCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | <div newline></div> |
- | * **Description**:None. | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
- | ==== Parameters ==== | + | * //The default implementation is to do nothing.// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | === Finalize() === | + | * //This method is the concrete wrapper for the virtual method CloseCore. It will return whatever is returned by the CloseCore method. To determine what the default implementation of the abstract CloseCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Void | + | * Type:Void |
- | * **Description**:N/A | + | * Description:None. |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | === GetFeaturesCore(RectangleShape) === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | This method returns a Collection of Features cached in the FeatureCache system. All of the returning features are within the BoundingBox and were fetched from FileSystem or DBSystem in a previous operation. | + | |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method GetFeaturesCore. It will return whatever is returned by the GetBoundingBoxCore method. To determine what the default implementation of the abstract GetBoundingBoxCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | == Remarks == |
- | * **Description**:This method returns a Collection of Features cached in the FeatureCache system. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **worldExtent** | + | * Type:Void |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | [[#Protected Methods|Go Back]] | + | == Parameters == |
- | === MemberwiseClone() === | + | <div newline></div> |
- | N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Object | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Object |
- | === OpenCore() === | + | * Description:N/A |
- | The default implementation is to do nothing. | + | |
- | ==== Remarks ==== | + | |
- | This method is the concrete wrapper for the virtual method OpenCore. It will return whatever is returned by the OpenCore method. To determine what the default implementation of the abstract OpenCore method is, please see the documentation for it. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | <div newline></div> |
- | * **Description**:None. | + | ==== Public Properties ==== |
+ | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === IsActive === | ||
This boolean property sepcifies whether cache system is active or not. | This boolean property sepcifies whether cache system is active or not. | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Boolean | + | * Type:Boolean |
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |