MgCoordinateSystemGridSpecification Class Reference

MgCoordinateSystemGridSpecification is an object that is used to convey all the parameters necessary for the generation of a grid/graticule lumped into a single object for convenience. Thus, adding a parameter determined to be necessary at a later time does not alter a lot of calling sequences. More...

Inheritance diagram for MgCoordinateSystemGridSpecification:

List of all members.

Public Member Functions
virtual double	GetCurvePrecision (void)=0
	Get the current curve precision value. same.
virtual double	GetEastingBase (void)=0
	Gets the easting base value.
virtual double	GetEastingIncrement (void)=0
	Gets the easting increment value (the interval between easting grid lines).
virtual double	GetNorthingBase (void)=0
	Gets the northing base value.
virtual double	GetNorthingIncrement (void)=0
	Gets the northing increment value.
virtual double	GetTickEastingIncrement (void)=0
	Gets the tick easting increment value.
virtual double	GetTickNorthingIncrement (void)=0
	Gets the tick northing increment value.
virtual INT32	GetUnitCode (void)=0
	Gets the current unit code setting.
virtual INT32	GetUnitType (void)=0
	Gets the current unit type setting.
virtual bool	IsConsistent (void)=0
	Checks the internal contents of the object for consistency.
virtual bool	IsSameAs (MgCoordinateSystemGridSpecification *specification)=0
	Determines if two MgCoordinateSystemGridSpecification objects are the same.
virtual void	SetCurvePrecision (double curvePrecision)=0
	Sets the desired precision of complex curve approximations.
virtual void	SetGridBase (double eastingBase, double northingBase)=0
	Sets the easting and northing base values.
virtual void	SetGridIncrement (double eastingIncrement, double northingIncrement)=0
	Sets the easting and northing grid line increment values.
virtual void	SetMaxCurvePoints (INT32 maxCurvePoints)=0
	Sets the maximum number of points to generate for a complex curve approximation.
virtual void	SetTickIncrements (double eastingIncrement, double northingIncrement)=0
	Sets the easting and northing tick increment values.
virtual void	SetUnits (INT32 unitCode, INT32 unitType)=0
	Sets the units used to define the desired grid.

---

Detailed Description

MgCoordinateSystemGridSpecification is an object that is used to convey all the parameters necessary for the generation of a grid/graticule lumped into a single object for convenience. Thus, adding a parameter determined to be necessary at a later time does not alter a lot of calling sequences.

Note that this interface is an abstract interface. There is code associated with the implementation of this interface which is used to handle the conversion of parameters between the various unit systems. Thus, one obtains a MgCoordinateSystemGridSpecification from the MgCoordinateSystemFactory object.

Note that all values are provided in the units specified within the object. The units used in this object do not need to be the same as any coordinate system involved in the generation of a grid, although the type of unit must be consistent with the type of grid being drawn. That is, specifying a Angular unit type when drawing a UTM grid will cause an exception at the time the request for (say) grid lines is issued.

Since:

2.2