Package com.luciad.format.magneticnorth

Class ALcdMagneticNorthModelDescriptor

java.lang.Object

com.luciad.model.TLcdModelDescriptor

com.luciad.model.TLcdDataModelDescriptor

com.luciad.format.magneticnorth.ALcdMagneticNorthModelDescriptor

All Implemented Interfaces:

ILcdAnnotatedElement, ILcdDataModelDescriptor, ILcdModelDescriptor, Serializable

Direct Known Subclasses:

TLcdMagneticNorthModelDescriptor

public abstract class ALcdMagneticNorthModelDescriptor
extends TLcdDataModelDescriptor
implements ILcdModelDescriptor, ILcdDataModelDescriptor

This class represents the model descriptor of an ILcdMagneticNorthModel. It consists of

• The magnetic north map used to perform the calculations
• A setting for the used precision.
• The degrees between two lines with the same value (e.g. calculate a line every 2 degrees)
• The bounds the calculations were performed in.

This class also implements ILcdDataModelDescriptor. The data type and data model for this descriptor can be found in the TLcdMagneticNorthDataTypes class.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ALcdMagneticNorthModelDescriptor()	Creates a new uninitialized TLcdMagneticNorthModelDescriptor object.

Method Summary

Modifier and Type	Method	Description
ILcdBounds	getBounds()	Returns the bounds the magnetic north declination was calculated for.
Calendar	getDate()	Returns the date this model was retrieved for.
int	getDegreesBetweenLines()	Deprecated. Use getStep() instead.
ILcdMagneticNorthMap	getMagneticNorthMap()	Returns the ILcdMagneticNorthMap used to create this model.
double	getPrecision()	Returns the precision.
double	getStep()	Returns the step in degrees between the iso lines of equal declination.

Methods inherited from class com.luciad.model.TLcdDataModelDescriptor

addAnnotation, getAnnotation, getAnnotations, getDataModel, getModelElementTypes, getModelTypes, isAnnotationPresent, removeAnnotation

Methods inherited from class com.luciad.model.TLcdModelDescriptor

getDisplayName, getSourceName, getTypeName, setDisplayName, setSourceName, setTypeName, sourceNameToDisplayName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdDataModelDescriptor

getDataModel, getModelElementTypes, getModelTypes

Methods inherited from interface com.luciad.model.ILcdModelDescriptor

getDisplayName, getSourceName, getTypeName

Constructor Details

ALcdMagneticNorthModelDescriptor

public ALcdMagneticNorthModelDescriptor()

Creates a new uninitialized TLcdMagneticNorthModelDescriptor object.

Method Details

getMagneticNorthMap

public ILcdMagneticNorthMap getMagneticNorthMap()

Returns the ILcdMagneticNorthMap used to create this model.

Returns:

the ILcdMagneticNorthMap used to create this model

getPrecision

public double getPrecision()

Returns the precision. Higher value is better precision, usable values between 0.1 and 1

Returns:

The currently used precision value

getDegreesBetweenLines

public int getDegreesBetweenLines()

Deprecated.

Use getStep() instead.

Returns:

the degrees between the lines.

getStep

public double getStep()

Returns the step in degrees between the iso lines of equal declination.

Returns:

the step in degrees between the iso lines of equal declination.

getDate

public Calendar getDate()

Returns the date this model was retrieved for.

Returns:

the date this model was retrieved for

getBounds

public ILcdBounds getBounds()

Returns the bounds the magnetic north declination was calculated for.

Returns:

The bounds the magnetic north declination was calculated for.