public class TLcdUPSGrid extends TLcdGridReference
ILcdGridReference
represents a UPS grid reference.
It is characterized by a boolean flag northPole, which specifies the pole.CARTESIAN, GEODETIC
Constructor and Description |
---|
TLcdUPSGrid()
Creates a new
TLcdUPSGrid for the North pole. |
TLcdUPSGrid(boolean aNorthPole)
Creates a new
TLcdUPSGrid for the given pole. |
Modifier and Type | Method and Description |
---|---|
String |
getName() |
boolean |
isNorthPole()
Returns whether the UPS zone is defined for the North pole,
if
true , or for the South pole, if false . |
void |
loadProperties(String aPrefix,
Properties aProperties)
This method will retrieve the properties of this
TLcdUPSGrid ,
based on the given Properties object and the given prefix. |
void |
setFalseEasting(double aFalseEasting)
Sets the
falseEasting of the TLcdGridReference
to aFalseEasting . |
void |
setFalseNorthing(double aFalseNorthing)
Sets the
falseNorthing of the TLcdGridReference
to aFalseNorthing . |
void |
setNorthPole(boolean aNorthPole)
Sets the pole of the UPS zone.
|
void |
setRotation(double aRotation)
Sets the rotation of this
ILcdGridReference in radians, clockwise. |
void |
setScale(double aScale)
Sets the
scale of the TLcdGridReference
to aScale . |
void |
setUnitOfMeasure(double aUnitOfMeasure)
Sets the UnitOfMeasure of the
TLcdGridReference
to aUnitOfMeasure . |
void |
writePropertiesSFCT(String aPrefix,
Properties aPropertiesSFCT)
Stores the properties that define this model reference into the specified
Properties object as a side
effect. |
clone, equals, get2DEditableBounds, getCoordinateType, getCosRotation, getFalseEasting, getFalseNorthing, getProjection, getRotation, getScale, getSinRotation, getUnitOfMeasure, hashCode, isBoundsAvailable, makeModelPoint, setProjection, toString
getGeodeticDatum, getModelReferenceMetadata, setGeodeticDatum, setModelReferenceMetadata, setName
finalize, getClass, notify, notifyAll, wait, wait, wait
getGeodeticDatum
public TLcdUPSGrid()
TLcdUPSGrid
for the North pole.public TLcdUPSGrid(boolean aNorthPole)
TLcdUPSGrid
for the given pole.aNorthPole
- specifies the North pole, if true
, or the
South pole, if false
.public boolean isNorthPole()
true
, or for the South pole, if false
.true
, or for the South pole, if false
.public void setNorthPole(boolean aNorthPole)
aNorthPole
- specifies the North pole, if true
, or the
South pole, if false
.public void setFalseEasting(double aFalseEasting)
TLcdGridReference
falseEasting
of the TLcdGridReference
to aFalseEasting
.setFalseEasting
in class TLcdGridReference
aFalseEasting
- the new false easting value for this reference
(defined in the unit of measure of this reference).TLcdGridReference.getFalseEasting()
public void setFalseNorthing(double aFalseNorthing)
TLcdGridReference
falseNorthing
of the TLcdGridReference
to aFalseNorthing
.setFalseNorthing
in class TLcdGridReference
aFalseNorthing
- the new false northing value for this reference
(defined in the unit of measure of this reference).TLcdGridReference.getFalseNorthing()
public void setScale(double aScale)
TLcdGridReference
scale
of the TLcdGridReference
to aScale
.setScale
in class TLcdGridReference
aScale
- the new scale value for this reference.TLcdGridReference.getScale()
public void setUnitOfMeasure(double aUnitOfMeasure)
TLcdGridReference
TLcdGridReference
to aUnitOfMeasure
.setUnitOfMeasure
in class TLcdGridReference
aUnitOfMeasure
- the new unitOfMeasure of this ILcdGridReference
w.r.t. meters.TLcdGridReference.getUnitOfMeasure()
public void setRotation(double aRotation)
TLcdGridReference
ILcdGridReference
in radians, clockwise. The center of the
rotation is the origin of the map projection.setRotation
in class TLcdGridReference
aRotation
- the new rotation value for this reference.TLcdGridReference.getRotation()
public void loadProperties(String aPrefix, Properties aProperties) throws IllegalArgumentException
TLcdUPSGrid
,
based on the given Properties
object and the given prefix.
The values of following optional keys are retrieved:
TLcdGeodeticDatumFactory
.
The keys of those entries should begin with
'<aPrefix>.TLcdUPSGrid.geodeticDatum.'.loadProperties
in interface ILcdModelReference
loadProperties
in class TLcdGridReference
aPrefix
- a common prefix for all property names that are read.aProperties
- the properties to be parsed.IllegalArgumentException
- if the model reference cannot be constructed from the properties.TLcdGeodeticDatumFactory
public void writePropertiesSFCT(String aPrefix, Properties aPropertiesSFCT) throws IllegalArgumentException
ILcdModelReference
Properties
object as a side
effect.
Each particular implementation of this interface can define which properties it stores.writePropertiesSFCT
in interface ILcdModelReference
writePropertiesSFCT
in class TLcdGridReference
aPrefix
- a common prefix for all property names written.aPropertiesSFCT
- the properties that will contain the serialized
properties for this model reference, as a side effect.IllegalArgumentException
- if the model reference cannot be serialized into properties.loadProperties(java.lang.String, java.util.Properties)
public String getName()
getName
in class ALcdGeoReference