thinkgeo.mapsuite.core.cogocall
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.cogocall [2015/09/17 10:26] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.CogoCall ====== | ||
| - | This is an abstract class which is the basis for each of the different types of COGO calls In the abstract class we define that a call need to be able to produce a line segment as well as produce its traverse and description string. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.Core.CogoCall** | ||
| - | *[[ThinkGeo.MapSuite.Core.AngleDistanceCogoCall]] | ||
| - | *[[ThinkGeo.MapSuite.Core.DirectionDistanceCogoCall]] | ||
| - | *[[ThinkGeo.MapSuite.Core.NonTangentCurveCogoCall]] | ||
| - | *[[ThinkGeo.MapSuite.Core.TangentCurveCogoCall]] | ||
| - | *[[ThinkGeo.MapSuite.Core.XYCogoCall]] | ||
| - | ===== Members Summary ===== | ||
| - | === Public Constructors === | ||
| - | === Protected Constructors === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#CogoCall()|CogoCall]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Public Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | ||
| - | * **Parameters**:Object | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetCallLine(PointShape,PointShape)|GetCallLine]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetDescriptionString(CogoDirectionType,AngleUnit)|GetDescriptionString]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetTraverseString(CogoDirectionType,AngleUnit)|GetTraverseString]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#LoadFromTraverseString(String,CogoDirectionType,AngleUnit)|LoadFromTraverseString]]** | ||
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Protected Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetCallLineCore(PointShape,PointShape)|GetCallLineCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetDescriptionStringCore(CogoDirectionType,AngleUnit)|GetDescriptionStringCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This abstract method has to be overridden in sub classes. It is responsible for converting the call into a descriptive string which will display on the call grid | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetTraverseStringCore(CogoDirectionType,AngleUnit)|GetTraverseStringCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This abstract method has to be overridden in sub classes. It is responsible for converting the call into a traverse string used to build up the traverse file for saving | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#LoadFromTraverseStringCore(String,CogoDirectionType,AngleUnit)|LoadFromTraverseStringCore]]** | ||
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]],[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method will populate this class from a single line of a traverse string | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Public Properties === | ||
| - | **{{wiki:PublicProperty.gif|}}[[#IsPointOfBeginning|IsPointOfBeginning]]** | ||
| - | * **Return**:Boolean | ||
| - | * **Summary**:This porperty denotes if this call is the point of begining. This is the point from which we will begin the polygon | ||
| - | |||
| - | === Protected Properties === | ||
| - | === Public Events === | ||
| - | ===== Public Constructors ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | === CogoCall() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Parameters ==== | ||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ===== Public Methods ===== | ||
| - | === Equals(Object) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Boolean | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **obj** | ||
| - | * **Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetCallLine(PointShape,PointShape) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **startPoint** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **backsightPoint** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetDescriptionString(CogoDirectionType,AngleUnit) === | ||
| - | This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **returningDirectionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **returningAngleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetHashCode() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetTraverseString(CogoDirectionType,AngleUnit) === | ||
| - | This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **returningDirectionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **returningAngleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetType() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Type | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === LoadFromTraverseString(String,CogoDirectionType,AngleUnit) === | ||
| - | This method is the concrete method which always calls the associated core method. This is used to give us, the framework designer, flexability when user override the core method. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **traverseString** | ||
| - | * **Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **directionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **angleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === ToString() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | === Finalize() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === GetCallLineCore(PointShape,PointShape) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **startPoint** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **backsightPoint** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | === GetDescriptionStringCore(CogoDirectionType,AngleUnit) === | ||
| - | This abstract method has to be overridden in sub classes. It is responsible for converting the call into a descriptive string which will display on the call grid | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **returningDirectionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **returningAngleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | === GetTraverseStringCore(CogoDirectionType,AngleUnit) === | ||
| - | This abstract method has to be overridden in sub classes. It is responsible for converting the call into a traverse string used to build up the traverse file for saving | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **returningDirectionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **returningAngleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | === LoadFromTraverseStringCore(String,CogoDirectionType,AngleUnit) === | ||
| - | This method will populate this class from a single line of a traverse string | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **traverseString** | ||
| - | * **Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **directionType** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **angleUnit** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#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 ===== | ||
| - | === IsPointOfBeginning === | ||
| - | This porperty denotes if this call is the point of begining. This is the point from which we will begin the polygon | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Boolean | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
thinkgeo.mapsuite.core.cogocall.1442485590.txt.gz ยท Last modified: 2015/09/17 10:26 by admin
