This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.degreesminutesseconds [2015/09/17 10:27] admin |
thinkgeo.mapsuite.core.degreesminutesseconds [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.DegreesMinutesSeconds ====== | ====== ThinkGeo.MapSuite.Core.DegreesMinutesSeconds ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This structure represents a degrees, minutes and seconds value. | This structure represents a degrees, minutes and seconds value. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 6: | Line 9: | ||
***ThinkGeo.MapSuite.Core.DegreesMinutesSeconds** | ***ThinkGeo.MapSuite.Core.DegreesMinutesSeconds** | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} DegreesMinutesSeconds(Int32,Int32,Double) ** |
- | **{{wiki:PublicMethod.gif|}}[[#DegreesMinutesSeconds(Int32,Int32,Double)|DegreesMinutesSeconds]]** | + | |
- | * **Parameters**:Int32,Int32,Double | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This constructor allows you to create an instance of the class by specifying the degree, minute and second values. | + | |
- | </div> | + | |
- | === Protected Constructors === | + | * //This constructor allows you to create an instance of the class by specifying the degree, minute and second values.// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //None// |
- | **{{wiki:PublicMethod.gif|}}[[#Add(DegreesMinutesSeconds)|Add]]** | + | == Parameters == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] | + | * //degrees// |
- | * **DeclaringType**:N/A | + | * Type:Int32 |
- | * **Summary**:Add two DegreesMinutsSeconds together and return back a summary of the two. | + | * Description:This parameter represents the degree portion of the structure. |
- | </div> | + | |
- | <div class_table> | + | * //minutes// |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | * Type:Int32 |
- | * **Parameters**:Object | + | * Description:This parameter represents the minute portion of the structure. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:Compares current DegreesMinutesSeconds with a passing object. | + | |
- | </div> | + | |
- | <div class_table> | + | * //seconds// |
- | **{{wiki:PublicMethod.gif|}}[[#GetFormattedString(Int32)|GetFormattedString]]** | + | * Type:Double |
- | * **Parameters**:Int32 | + | * Description:This parameter represents the second portion of the structure. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#GetFormattedString(DegreesMinutesSecondsFormatType)|GetFormattedString]]** | + | ==== Protected Constructors ==== |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | + | ==== Public Methods ==== |
- | * **DeclaringType**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //Serves as hash function for the particular type.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetFormattedString(DegreesMinutesSecondsFormatType,Int32)|GetFormattedString]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]],Int32 | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:Int32 |
- | * **Parameters**:N/A | + | * Description:The hash code for this particular type. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:Serves as hash function for the particular type. | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | <div newline></div> |
- | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //Compares current DegreesMinutesSeconds with a passing object.// |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns a formatted representation of the degrees, minutes and seconds value. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#ToString(Int32)|ToString]]** | + | * Type:Boolean |
- | * **Parameters**:Int32 | + | * Description:True if the passing object satisfies the following two conditions:1) The object is of DegreesMinutesSeconds type.2) The Degrees, Minutes and Seconds of both DegreesMinutesSeconds should be the same.If both conditions are not met, will return false. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | == Parameters == |
- | <div class_table> | + | * //obj// |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * Type:Object |
- | * **Parameters**:N/A | + | * Description:The passing object which will be used to compare with current DegreesMinutesSeconds. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | ** {{wiki:PublicMethod.gif|}} Add(DegreesMinutesSeconds) ** |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | * //Add two DegreesMinutsSeconds together and return back a summary of the two.// |
- | **{{wiki:PublicProperty.gif|}}[[#Degrees|Degrees]]** | + | == Remarks == |
- | * **Return**:Int32 | + | * //N/A// |
- | * **Summary**:This property returns the degrees portion of the structure. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#Minutes|Minutes]]** | + | == Return Value == |
- | * **Return**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] |
- | * **Summary**:This property returns the minutes portion of the structure. | + | * Description:The summary of the two DegreesMinutesSeconds. |
- | **{{wiki:PublicProperty.gif|}}[[#Seconds|Seconds]]** | + | == Parameters == |
- | * **Return**:Double | + | * //targetDegreesMinutesSeconds// |
- | * **Summary**:This property returns the seconds portion of the structure. | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] |
+ | * Description:The target DegreesMinutesSeconds to be added together. | ||
- | === Protected Properties === | + | <div newline></div> |
- | === Public Events === | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | ===== Public Constructors ===== | + | |
- | === DegreesMinutesSeconds(Int32,Int32,Double) === | + | |
- | This constructor allows you to create an instance of the class by specifying the degree, minute and second values. | + | |
- | ==== Remarks ==== | + | |
- | None | + | |
- | ==== Parameters ==== | + | |
- | **degrees** | + | |
- | * **Type**:Int32 | + | |
- | * **Description:This parameter represents the degree portion of the structure. | + | |
- | **minutes** | + | * //This method returns a formatted representation of the degrees, minutes and seconds value.// |
- | * **Type**:Int32 | + | == Remarks == |
- | * **Description:This parameter represents the minute portion of the structure. | + | * //The value will be formatted in the standard string format: 75º 21' 28"// |
- | **seconds** | + | == Return Value == |
- | * **Type**:Double | + | * Type:String |
- | * **Description:This parameter represents the second portion of the structure. | + | * Description:This method returns a formatted representation of the degrees, minutes and seconds value. |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ===== Protected Constructors ===== | + | <div newline></div> |
- | ===== Public Methods ===== | + | ** {{wiki:PublicMethod.gif|}} ToString(Int32) ** |
- | === Add(DegreesMinutesSeconds) === | + | |
- | Add two DegreesMinutsSeconds together and return back a summary of the two. | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] | + | == Remarks == |
- | * **Description**:The summary of the two DegreesMinutesSeconds. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **targetDegreesMinutesSeconds** | + | * Type:String |
- | * **Type**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] | + | * Description:N/A |
- | * **Description**:The target DegreesMinutesSeconds to be added together. | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === Equals(Object) === | + | * //decimals// |
- | Compares current DegreesMinutesSeconds with a passing object. | + | * Type:Int32 |
- | ==== Remarks ==== | + | * Description:N/A |
- | N/A | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:Boolean | + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(Int32) ** |
- | * **Description**:True if the passing object satisfies the following two conditions:1) The object is of DegreesMinutesSeconds type.2) The Degrees, Minutes and Seconds of both DegreesMinutesSeconds should be the same.If both conditions are not met, will return false. | + | |
- | ==== Parameters ==== | + | * //This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals.// |
- | **obj** | + | == Remarks == |
- | * **Type**:Object | + | * //The value will be formatted in the standard string format. For example, 75º 21' 2.1235" (when the decimals parameter is set to 4).// |
- | * **Description**:The passing object which will be used to compare with current DegreesMinutesSeconds. | + | |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === GetFormattedString(Int32) === | + | * Type:String |
- | This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals. | + | * Description:This method returns a formatted representation of the degrees, minutes and seconds value. |
- | ==== Remarks ==== | + | |
- | The value will be formatted in the standard string format. For example, 75º 21' 2.1235" (when the decimals parameter is set to 4). | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:String | + | * //decimals// |
- | * **Description**:This method returns a formatted representation of the degrees, minutes and seconds value. | + | * Type:Int32 |
+ | * Description:The target decimals that the degrees, minutes, seconds value will be rounded to. | ||
- | ==== Parameters ==== | + | <div newline></div> |
- | **decimals** | + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(DegreesMinutesSecondsFormatType) ** |
- | * **Type**:Int32 | + | |
- | * **Description**:The target decimals that the degrees, minutes, seconds value will be rounded to. | + | |
- | [[#Public Methods|Go Back]] | + | * //N/A// |
- | === GetFormattedString(DegreesMinutesSecondsFormatType) === | + | == Remarks == |
- | N/A | + | * //N/A// |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:String | + | * Type:String |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | **formatType** | + | * //formatType// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] |
- | * **Description**:N/A | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === GetFormattedString(DegreesMinutesSecondsFormatType,Int32) === | + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(DegreesMinutesSecondsFormatType,Int32) ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:String | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **formatType** | + | * Type:String |
- | * **Type**:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | **decimals** | + | == Parameters == |
- | * **Type**:Int32 | + | * //formatType// |
- | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] |
+ | * Description:N/A | ||
- | [[#Public Methods|Go Back]] | + | * //decimals// |
- | === GetHashCode() === | + | * Type:Int32 |
- | Serves as hash function for the particular type. | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:Int32 | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | * **Description**:The hash code for this particular type. | + | |
- | ==== 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> |
- | === ToString() === | + | ==== Protected Methods ==== |
- | This method returns a formatted representation of the degrees, minutes and seconds value. | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | ==== Remarks ==== | + | |
- | The value will be formatted in the standard string format: 75º 21' 28" | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:String | + | == Remarks == |
- | * **Description**:This method returns a formatted representation of the degrees, minutes and seconds value. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | === ToString(Int32) === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:String | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **decimals** | + | == Remarks == |
- | * **Type**:Int32 | + | * //N/A// |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | ===== Protected Methods ===== | + | * Type:Object |
- | === Finalize() === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | <div newline></div> |
- | * **Description**:N/A | + | ==== Public Properties ==== |
+ | ** {{wiki:PublicProperty.gif|}} Degrees ** | ||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | === MemberwiseClone() === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:Object | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === Degrees === | ||
This property returns the degrees portion of the structure. | This property returns the degrees portion of the structure. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Int32 | + | * Type:Int32 |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Minutes ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === Minutes === | ||
This property returns the minutes portion of the structure. | This property returns the minutes portion of the structure. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Int32 | + | * Type:Int32 |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Seconds ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === Seconds === | ||
This property returns the seconds portion of the structure. | This property returns the seconds portion of the structure. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Double | + | * Type:Double |
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |