thinkgeo.mapsuite.core.cogocall
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.cogocall [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.CogoCall ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | 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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CogoCall()|CogoCall]] | | | | | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCallLine(PointShape, PointShape)|GetCallLine]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDescriptionString(CogoDirectionType, AngleUnit)|GetDescriptionString]] | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|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. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetTraverseString(CogoDirectionType, AngleUnit)|GetTraverseString]] | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|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. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LoadFromTraverseString(String, CogoDirectionType, AngleUnit)|LoadFromTraverseString]] | String, [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|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. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCallLineCore(PointShape, PointShape)|GetCallLineCore]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetDescriptionStringCore(CogoDirectionType, AngleUnit)|GetDescriptionStringCore]] | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|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 | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetTraverseStringCore(CogoDirectionType, AngleUnit)|GetTraverseStringCore]] | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|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 | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadFromTraverseStringCore(String, CogoDirectionType, AngleUnit)|LoadFromTraverseStringCore]] | String, [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]], [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]] | | This method will populate this class from a single line of a traverse string | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsPointOfBeginning|IsPointOfBeginning]] | Boolean | | This porperty denotes if this call is the point of begining. This is the point from which we will begin the polygon | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | ==== CogoCall() ==== | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetCallLine(PointShape, PointShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | ||
| - | | backsightPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | returningDirectionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | returningAngleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | returningDirectionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | returningAngleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | traverseString | String<!-- System.String --> | | | ||
| - | | directionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | angleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetCallLineCore(PointShape, PointShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | ||
| - | | backsightPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#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 | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | returningDirectionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | returningAngleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#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 | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | returningDirectionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | returningAngleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== LoadFromTraverseStringCore(String, CogoDirectionType, AngleUnit) ==== | ||
| - | This method will populate this class from a single line of a traverse string | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | traverseString | String<!-- System.String --> | | | ||
| - | | directionType | [[ThinkGeo.MapSuite.Core.CogoDirectionType|CogoDirectionType]]<!-- ThinkGeo.MapSuite.Core.CogoDirectionType --> | | | ||
| - | | angleUnit | [[ThinkGeo.MapSuite.Core.AngleUnit|AngleUnit]]<!-- ThinkGeo.MapSuite.Core.AngleUnit --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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 | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.CogoCall --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.cogocall.1440040128.txt.gz ยท Last modified: 2015/09/17 08:57 (external edit)
