Package org.apache.sis.parameter

Class MapProjectionParameters.EarthRadius

java.lang.Object

org.apache.sis.io.wkt.FormattableObject

org.apache.sis.parameter.DefaultParameterValue<Double>

org.apache.sis.parameter.MapProjectionParameters.EarthRadius

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, org.opengis.parameter.GeneralParameterValue, org.opengis.parameter.ParameterValue<Double>

Enclosing class:

MapProjectionParameters

static final class MapProjectionParameters.EarthRadius
extends DefaultParameterValue<Double>

The earth radius parameter. This parameter is computed automatically from the "semi_major" and "semi_minor" parameters. When explicitly set, this parameter value is also assigned to the "semi_major" and "semi_minor" axis lengths.

See Also:

• DefaultEllipsoid.getAuthalicRadius()

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final org.opengis.parameter.ParameterDescriptor<Double>	DESCRIPTOR	All names known to Apache SIS for the Earth radius parameter.
private final org.opengis.parameter.ParameterValue<?>	semiMajor	The parameters for the semi-major and semi-minor axis length.
private final org.opengis.parameter.ParameterValue<?>	semiMinor	The parameters for the semi-major and semi-minor axis length.
private static final long	serialVersionUID	For cross-version compatibility.

Fields inherited from class org.apache.sis.parameter.DefaultParameterValue

unit, value

Constructor Summary

Constructors

Constructor	Description
EarthRadius(org.opengis.parameter.ParameterValue<?> semiMajor, org.opengis.parameter.ParameterValue<?> semiMinor)	Creates a new parameter.

Method Summary

Modifier and Type	Method	Description
double	doubleValue()	Invoked when the parameter value is requested.
javax.measure.Unit<?>	getUnit()	Unconditionally returns the unit of the semi-major axis, which is the unit in which doubleValue() performs its computation.
Double	getValue()	Getters other than the above doubleValue() delegate to this method.
protected void	setValue(Object value, javax.measure.Unit<?> unit)	Invoked when a new parameter value is set.

Methods inherited from class org.apache.sis.parameter.DefaultParameterValue

booleanValue, clone, doubleValue, doubleValueList, doubleValueList, equals, equals, formatTo, getDescriptor, hashCode, intValue, intValueList, setDescriptor, setValue, setValue, setValue, setValue, setValue, setValue, stringValue, unmodifiable, validate, valueFile

Methods inherited from class org.apache.sis.io.wkt.FormattableObject

print, toString, toString, toWKT

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility. Actually instances of this class are not expected to be serialized, but we try to be a bit safer here.

See Also:

• Constant Field Values

DESCRIPTOR

static final org.opengis.parameter.ParameterDescriptor<Double> DESCRIPTOR

All names known to Apache SIS for the Earth radius parameter. This is used in some netCDF files instead of SEMI_MAJOR and SEMI_MINOR. This is not a standard parameter.

semiMajor

private final org.opengis.parameter.ParameterValue<?> semiMajor

The parameters for the semi-major and semi-minor axis length.

semiMinor

private final org.opengis.parameter.ParameterValue<?> semiMinor

The parameters for the semi-major and semi-minor axis length.

Constructor Details

EarthRadius

EarthRadius(org.opengis.parameter.ParameterValue<?> semiMajor,
 org.opengis.parameter.ParameterValue<?> semiMinor)

Creates a new parameter.

Method Details

setValue

protected void setValue(Object value,
 javax.measure.Unit<?> unit)

Invoked when a new parameter value is set. This method sets both axis length to the given radius.

Overrides:

setValue in class DefaultParameterValue<Double>

Parameters:

value - the parameter value, or null to restore the default.

unit - the unit associated to the new parameter value, or null.

See Also:

• DefaultParameterValue.validate(Object)

doubleValue

public double doubleValue()

Invoked when the parameter value is requested. Unconditionally computes the authalic radius. If an Earth radius has been explicitly specified, the result will be the same unless the user overwrote it with explicit semi-major or semi-minor axis length.

Specified by:

doubleValue in interface org.opengis.parameter.ParameterValue<Double>

Overrides:

doubleValue in class DefaultParameterValue<Double>

Returns:

the numeric value represented by this parameter after conversion to type double. This method returns Double.NaN only if such "value" has been explicitly set.

See Also:

• DefaultParameterValue.getUnit()
• DefaultParameterValue.setValue(double)
• DefaultParameterValue.doubleValueList()
• Parameters.doubleValue(ParameterDescriptor)

getUnit

public javax.measure.Unit<?> getUnit()

Unconditionally returns the unit of the semi-major axis, which is the unit in which doubleValue() performs its computation.

Specified by:

getUnit in interface org.opengis.parameter.ParameterValue<Double>

Overrides:

getUnit in class DefaultParameterValue<Double>

Returns:

the unit of measure, or null if none.

See Also:

• DefaultParameterValue.doubleValue()
• DefaultParameterValue.doubleValueList()
• DefaultParameterValue.getValue()

getValue

public Double getValue()

Getters other than the above doubleValue() delegate to this method.

Specified by:

getValue in interface org.opengis.parameter.ParameterValue<Double>

Overrides:

getValue in class DefaultParameterValue<Double>

Returns:

the parameter value as an object, or null if no value has been set and there is no default value.

See Also:

• DefaultParameterValue.setValue(Object)
• Parameters.getValue(ParameterDescriptor)