org.britastro.grelf.astro

Class DeepSkyObject

java.lang.Object

org.britastro.grelf.astro.DeepSkyObject

All Implemented Interfaces:

SkyObject

public class DeepSkyObject
extends java.lang.Object
implements SkyObject

Holding the properties of a deep sky object (id and position).

Constructor Summary

Constructors

Constructor and Description
DeepSkyObject(java.lang.String ngcId, java.lang.String messierId, SkyPoint position)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommonId() Comprising the letter M (for Messier) and number.
java.lang.String	getId() If there is a commonId (Messier) return that; otherwise if there is an ngcId return that; otherwise return an empty string.
Magnitude	getMagnitude() If the object's magnitude is unknown this returns null.
java.lang.String	getNgcId()
SkyVector	getOffsetFromTarget() Typically the offset from the centre of a star chart or the axis of a cone search.
java.awt.Point	getPlotPoint() Set when the object is first plotted, to avoid recalculation when redrawing.
SkyPoint	getPosition() If the object's position is unknown this returns null.
void	setCommonId(java.lang.String id)
void	setMagnitude(Magnitude m)
void	setNgcId(java.lang.String id)
void	setOffsetFromTarget(SkyVector offset)
void	setPlotPoint(java.awt.Point pt)
void	setPosition(SkyPoint pt)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeepSkyObject

public DeepSkyObject(java.lang.String ngcId,
             java.lang.String messierId,
             SkyPoint position)

Method Detail

getId

public java.lang.String getId()

If there is a commonId (Messier) return that; otherwise if there is an ngcId return that; otherwise return an empty string.

Specified by:

getId in interface SkyObject

getCommonId

public java.lang.String getCommonId()

Comprising the letter M (for Messier) and number.

Specified by:

getCommonId in interface SkyObject

setCommonId

public void setCommonId(java.lang.String id)

getNgcId

public java.lang.String getNgcId()

setNgcId

public void setNgcId(java.lang.String id)

getPosition

public SkyPoint getPosition()

If the object's position is unknown this returns null.

Specified by:

getPosition in interface SkyObject

setPosition

public void setPosition(SkyPoint pt)

Specified by:

setPosition in interface SkyObject

setPlotPoint

public void setPlotPoint(java.awt.Point pt)

Specified by:

setPlotPoint in interface SkyObject

getPlotPoint

public java.awt.Point getPlotPoint()

Description copied from interface: SkyObject

Set when the object is first plotted, to avoid recalculation when redrawing.

Specified by:

getPlotPoint in interface SkyObject

setOffsetFromTarget

public void setOffsetFromTarget(SkyVector offset)

Specified by:

setOffsetFromTarget in interface SkyObject

getOffsetFromTarget

public SkyVector getOffsetFromTarget()

Description copied from interface: SkyObject

Typically the offset from the centre of a star chart or the axis of a cone search.

Specified by:

getOffsetFromTarget in interface SkyObject

getMagnitude

public Magnitude getMagnitude()

Description copied from interface: SkyObject

If the object's magnitude is unknown this returns null.

Specified by:

getMagnitude in interface SkyObject

setMagnitude

public void setMagnitude(Magnitude m)

Specified by:

setMagnitude in interface SkyObject