thinkgeo.mapsuite.core.degreesminutesseconds
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.degreesminutesseconds [2015/08/20 03:08] 127.0.0.1 external edit |
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}} | ||
| - | |||
| - | <!-- Structure --> | ||
| This structure represents a degrees, minutes and seconds value. | This structure represents a degrees, minutes and seconds value. | ||
| - | === Remarks === | ||
| - | This structure is used in many places to represent decimal degree numbers as degrees, minutes and seconds. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.ValueType | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds]] | + | *System.ValueType |
| + | ***ThinkGeo.MapSuite.Core.DegreesMinutesSeconds** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} DegreesMinutesSeconds(Int32,Int32,Double) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DegreesMinutesSeconds(Int32, Int32, Double)|DegreesMinutesSeconds]] | Int32, Int32, Double | | This constructor allows you to create an instance of the class by specifying the degree, minute and second values. | | + | |
| - | ==== Protected Constructors ==== | + | * //This constructor allows you to create an instance of the class by specifying the degree, minute and second values.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //None// | ||
| + | == Parameters == | ||
| + | * //degrees// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter represents the degree portion of the structure. | ||
| + | * //minutes// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter represents the minute portion of the structure. | ||
| + | |||
| + | * //seconds// | ||
| + | * Type:Double | ||
| + | * Description:This parameter represents the second portion of the structure. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Add(DegreesMinutesSeconds)|Add]] | [[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] | | Add two DegreesMinutsSeconds together and return back a summary of the two. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object(overriden) | Compares current DegreesMinutesSeconds with a passing object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFormattedString(Int32)|GetFormattedString]] | Int32 | | This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFormattedString(DegreesMinutesSecondsFormatType)|GetFormattedString]] | [[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFormattedString(DegreesMinutesSecondsFormatType, Int32)|GetFormattedString]] | [[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]], Int32 | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object(overriden) | Serves as hash function for the particular type. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object(overriden) | This method returns a formatted representation of the degrees, minutes and seconds value. | | + | |
| - | ==== Protected Methods ==== | + | * //Serves as hash function for the particular type.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Int32 |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Degrees|Degrees]] | Int32 | | This property returns the degrees portion of the structure. | | + | * Description:The hash code for this particular type. |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Minutes|Minutes]] | Int32 | | This property returns the minutes portion of the structure. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Seconds|Seconds]] | Double | | This property returns the seconds portion of the structure. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | ==== Public Events ==== | + | * //Compares current DegreesMinutesSeconds with a passing object.// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== DegreesMinutesSeconds(Int32, Int32, Double) ==== | + | * Type:Boolean |
| - | This constructor allows you to create an instance of the class by specifying the degree, minute and second values. | + | * 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 === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | degrees | Int32<!-- System.Int32 --> | This parameter represents the degree portion of the structure. | | + | |
| - | | minutes | Int32<!-- System.Int32 --> | This parameter represents the minute portion of the structure. | | + | |
| - | | seconds | Double<!-- System.Double --> | This parameter represents the second portion of the structure. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | * //obj// |
| - | ===== Public Methods ===== | + | * Type:Object |
| - | ==== Add(DegreesMinutesSeconds) ==== | + | * Description:The passing object which will be used to compare with current DegreesMinutesSeconds. |
| - | Add two DegreesMinutsSeconds together and return back a summary of the two. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]]<!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | The summary of the two DegreesMinutesSeconds. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} Add(DegreesMinutesSeconds) ** |
| - | | targetDegreesMinutesSeconds | [[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]]<!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | The target DegreesMinutesSeconds to be added together. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | + | * //Add two DegreesMinutsSeconds together and return back a summary of the two.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== Equals(Object) ==== | + | * //N/A// |
| - | Compares current DegreesMinutesSeconds with a passing object. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] |
| - | | obj | Object<!-- System.Object --> | The passing object which will be used to compare with current DegreesMinutesSeconds. | | + | * Description:The summary of the two DegreesMinutesSeconds. |
| - | <!-- System.Object(overriden) --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetDegreesMinutesSeconds// |
| - | ==== GetFormattedString(Int32) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSeconds|DegreesMinutesSeconds]] |
| - | This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals. | + | * Description:The target DegreesMinutesSeconds to be added together. |
| - | === 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 === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | This method returns a formatted representation of the degrees, minutes and seconds value. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | decimals | Int32<!-- System.Int32 --> | The target decimals that the degrees, minutes, seconds value will be rounded to. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | + | * //This method returns a formatted representation of the degrees, minutes and seconds value.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFormattedString(DegreesMinutesSecondsFormatType) ==== | + | * //The value will be formatted in the standard string format: 75º 21' 28"// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | formatType | [[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]]<!-- ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType --> | | | + | * Description:This method returns a formatted representation of the degrees, minutes and seconds value. |
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetFormattedString(DegreesMinutesSecondsFormatType, Int32) ==== | + | ** {{wiki:PublicMethod.gif|}} ToString(Int32) ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | formatType | [[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]]<!-- ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType --> | | | + | * //N/A// |
| - | | decimals | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | Serves as hash function for the particular type. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | The hash code for this particular type. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //decimals// |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | <!-- System.Object(overriden) --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(Int32) ** |
| - | ==== GetType() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //This method returns a formatted representation of the degrees, minutes and seconds value that has been rounded to the specified decimals.// |
| - | ^ Name ^ Type ^ Description ^ | + | == 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).// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== ToString() ==== | + | * Description:This method returns a formatted representation of the degrees, minutes and seconds value. |
| - | This method returns a formatted representation of the degrees, minutes and seconds value. | + | |
| - | === Remarks === | + | |
| - | The value will be formatted in the standard string format: 75º 21' 28" | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | This method returns a formatted representation of the degrees, minutes and seconds value. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //decimals// |
| + | * Type:Int32 | ||
| + | * Description:The target decimals that the degrees, minutes, seconds value will be rounded to. | ||
| - | <!-- System.Object(overriden) --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(DegreesMinutesSecondsFormatType) ** |
| - | ===== Protected Methods ===== | + | |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:String |
| - | ==== MemberwiseClone() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //formatType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFormattedString(DegreesMinutesSecondsFormatType,Int32) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //formatType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DegreesMinutesSecondsFormatType|DegreesMinutesSecondsFormatType]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //decimals// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} Degrees ** | ||
| - | <!-- System.Object --> | ||
| - | [[#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. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | None |
| - | | Int32<!-- System.Int32 --> | | + | == Return Value == |
| + | * Type:Int32 | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Minutes ** | ||
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Minutes ==== | ||
| This property returns the minutes portion of the structure. | This property returns the minutes portion of the structure. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | None |
| - | | Int32<!-- System.Int32 --> | | + | == Return Value == |
| + | * Type:Int32 | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Seconds ** | ||
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Seconds ==== | ||
| This property returns the seconds portion of the structure. | This property returns the seconds portion of the structure. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | None |
| - | | Double<!-- System.Double --> | | + | == Return Value == |
| + | * Type:Double | ||
| - | <!-- ThinkGeo.MapSuite.Core.DegreesMinutesSeconds --> | + | ==== Protected Properties ==== |
| - | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:MapSuiteCore]] | + | |
| - | [[Category:ThinkGeo.MapSuite.Core]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |
thinkgeo.mapsuite.core.degreesminutesseconds.1440040128.txt.gz · Last modified: 2015/09/17 08:58 (external edit)