This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.core.conversion [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.conversion [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.Conversion ====== | ====== ThinkGeo.MapSuite.Core.Conversion ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This static class provides a conversion method to go to and from different units. | This static class provides a conversion method to go to and from different units. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.Core.Conversion]] | + | ***ThinkGeo.MapSuite.Core.Conversion** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | |||
==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | |||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ConvertAngleUnits(Double, AngleUnit, AngleUnit)|ConvertAngleUnits]] | Double, [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]], [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ConvertMeasureUnits(Double, DistanceUnit, DistanceUnit)|ConvertMeasureUnits]] | Double, [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]], [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | | This method converts from one unit of measure to another. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#ConvertMeasureUnits(Double, AreaUnit, AreaUnit)|ConvertMeasureUnits]] | Double, [[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]], [[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | | This method converts from one unit of measure to another. | | + | |
- | | {{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 | | | + | |
+ | * //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|}} ConvertMeasureUnits(Double,DistanceUnit,DistanceUnit) ** | ||
+ | |||
+ | * //This method converts from one unit of measure to another.// | ||
+ | == Remarks == | ||
+ | * //None// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | * Description:The return length size, represented in the unit specified in the toUnit parameter. | ||
+ | |||
+ | == Parameters == | ||
+ | * //amount// | ||
+ | * Type:Double | ||
+ | * Description:The total length size, represented in the unit specified in the fromUnit parameter. | ||
+ | |||
+ | * //fromUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
+ | * Description:The unit of measure for the length in the Amount parameter. | ||
+ | |||
+ | * //toUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
+ | * Description:The unit of measure for the result. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ConvertMeasureUnits(Double,AreaUnit,AreaUnit) ** | ||
+ | |||
+ | * //This method converts from one unit of measure to another.// | ||
+ | == Remarks == | ||
+ | * //None// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | * Description:The return area size, represented in the unit specified in the toUnit parameter. | ||
+ | |||
+ | == Parameters == | ||
+ | * //amount// | ||
+ | * Type:Double | ||
+ | * Description:The total area size, represented in the unit specified in the fromUnit parameter. | ||
+ | |||
+ | * //fromUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | ||
+ | * Description:The unit of measure for the area in the Amount parameter. | ||
+ | |||
+ | * //toUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | ||
+ | * Description:The unit of measure for the result. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ConvertAngleUnits(Double,AngleUnit,AngleUnit) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //angle// | ||
+ | * Type:Double | ||
+ | * Description:N/A | ||
+ | |||
+ | * //fromUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
+ | * Description:N/A | ||
+ | |||
+ | * //toUnit// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
==== Protected Methods ==== | ==== Protected Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | ==== Public Properties ==== | + | * //N/A// |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
- | ==== Protected Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
+ | * Description:N/A | ||
- | ==== Public Events ==== | + | == Parameters == |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
+ | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | ===== Public Constructors ===== | + | * //N/A// |
- | ===== Protected Constructors ===== | + | == Remarks == |
- | ===== Public Methods ===== | + | * //N/A// |
- | ==== ConvertAngleUnits(Double, AngleUnit, AngleUnit) ==== | + | |
- | <!-- static --> | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Double<!-- System.Double --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
- | | angle | Double<!-- System.Double --> | | | + | * Description:N/A |
- | | fromUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | + | |
- | | toUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Conversion --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ==== ConvertMeasureUnits(Double, DistanceUnit, DistanceUnit) ==== | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ConvertScreenMeasureUnits(Double,ScreenUnit,ScreenUnit) ** |
- | <!-- static --> | + | |
- | This method converts from one unit of measure to another. | + | |
- | === Overloads === | + | |
- | This overload handles length units. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Double<!-- System.Double --> | The return length size, represented in the unit specified in the toUnit parameter. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | amount | Double<!-- System.Double --> | The total length size, represented in the unit specified in the fromUnit parameter. | | + | * //N/A// |
- | | fromUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | The unit of measure for the length in the Amount parameter. | | + | |
- | | toUnit | [[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.Core.DistanceUnit --> | The unit of measure for the result. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Conversion --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Double |
- | ==== ConvertMeasureUnits(Double, AreaUnit, AreaUnit) ==== | + | * Description:N/A |
- | <!-- static --> | + | |
- | This method converts from one unit of measure to another. | + | |
- | === Overloads === | + | |
- | This overload handles area units. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Double<!-- System.Double --> | The return area size, represented in the unit specified in the toUnit parameter. | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //amount// |
- | | amount | Double<!-- System.Double --> | The total area size, represented in the unit specified in the fromUnit parameter. | | + | * Type:Double |
- | | fromUnit | [[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]]<!-- ThinkGeo.MapSuite.Core.AreaUnit --> | The unit of measure for the area in the Amount parameter. | | + | * Description:N/A |
- | | toUnit | [[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]]<!-- ThinkGeo.MapSuite.Core.AreaUnit --> | The unit of measure for the result. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Conversion --> | + | * //fromUnit// |
- | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenUnit|ScreenUnit]] |
- | ==== Equals(Object) ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | * //toUnit// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenUnit|ScreenUnit]] |
- | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ConvertGeographyUnitToDistanceUnit(GeographyUnit) ** |
- | ==== GetHashCode() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | * //This method returns a DistanceUnit that has been converted from a GeographyUnit.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //None// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
- | ==== GetType() ==== | + | * Description:This method returns a DistanceUnit that has been converted from a GeographyUnit. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //unit// |
+ | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
+ | * Description:The GeographyUnit you want to convert. | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} DegreesToRadians(Single) ** |
- | ==== ToString() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Double |
- | ===== Protected Methods ===== | + | * Description:N/A |
- | ==== Finalize() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //degrees// |
+ | * Type:Single | ||
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetBearing(PointShape,PointShape) ** |
- | ==== MemberwiseClone() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Double |
- | ===== Public Properties ===== | + | * Description:N/A |
- | ===== Protected Properties ===== | + | |
- | ===== Public Events ===== | + | == Parameters == |
- | __NOTOC__ | + | * //p1// |
- | [[Category:MapSuiteCore]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
- | [[Category:ThinkGeo.MapSuite.Core]] | + | * Description:N/A |
- | [[Category:UpdateDocumentation]] | + | |
+ | * //p2// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetRegulateAngle(Double) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //angle// | ||
+ | * Type:Double | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Public Properties ==== | ||
+ | ==== Protected Properties ==== | ||
+ | ==== Public Events ==== | ||