Class AstronomyObject

java.lang.Object
  AstronomyObject

 class AstronomyObject
extends java.lang.Object

The class AstronomyObject contains methods to perform various operations relating to the science or guide object associated with a particular fibre or fiducial position.

Field Summary

private int	DecDegrees
private int	DecMinutes
private double	DecSeconds
private java.lang.String	DecString
private java.lang.String	Identity
private double	Magnitude
private java.lang.String	Name
private int	RaDegrees
private int	RaMinutes
private double	RaSeconds
private java.lang.String	RaString
private java.lang.String	Type
private double	Weight

Constructor Summary

AstronomyObject()

Method Summary

(package private) java.lang.String	getDec() Get the declination of the object
(package private) double	getMagnitude() Get the magnitude
(package private) java.lang.String	getName() Get the name of the object
(package private) java.lang.String	getRa() Get the RA of the object
(package private) java.lang.String	getType() Return the object's type
(package private) double	getWeight() Return the object's weighting
(package private) boolean	isDecValid(java.lang.String dec) Validate the Dec string
(package private) boolean	isFiducialObject() Is the object a fiducial object type
(package private) boolean	isRaValid(java.lang.String ra) Validate the RA string
(package private) boolean	isScienceObject() Is the object a science object type
(package private) void	setDec(java.lang.String dec) Set the Declination of the object
(package private) void	setFiducialObject() Set the object type as a fiducial object
(package private) void	setIdentity(java.lang.String theObjectIdentity) Set the identity of the object
(package private) void	setMagnitude(double theObjectMagnitude) Set the object's magnitude
(package private) void	setName(java.lang.String theObjectName) Set the name of the object
(package private) void	setRa(java.lang.String ra) Set the RA of the object
(package private) void	setScienceObject() Set the object type as a science object
(package private) void	setType(java.lang.String theObjectType) Set the object's type
(package private) void	setWeight(double theObjectWeight) Set the weighting value of the object
java.lang.String	toString() Returns a string representation of the object

Methods inherited from class java.lang.Object

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

Field Detail

Name

private java.lang.String Name

Weight

private double Weight

Type

private java.lang.String Type

Magnitude

private double Magnitude

Identity

private java.lang.String Identity

RaDegrees

private int RaDegrees

RaMinutes

private int RaMinutes

RaSeconds

private double RaSeconds

RaString

private java.lang.String RaString

DecDegrees

private int DecDegrees

DecMinutes

private int DecMinutes

DecSeconds

private double DecSeconds

DecString

private java.lang.String DecString

Constructor Detail

AstronomyObject

AstronomyObject()

Method Detail

setName

void setName(java.lang.String theObjectName)

Set the name of the object

Parameters:

theObjectName - The object's name

setRa

void setRa(java.lang.String ra)

Set the RA of the object

Parameters:

ra - The RA degrees

setDec

void setDec(java.lang.String dec)

Set the Declination of the object

Parameters:

dec - The declination

isRaValid

boolean isRaValid(java.lang.String ra)

Validate the RA string

Parameters:

ra - The RA

Returns:

Boolean to indicate validity of the RA

isDecValid

boolean isDecValid(java.lang.String dec)

Validate the Dec string

Parameters:

dec - The Dec

Returns:

Boolean to indicate validity of the Dec

setType

void setType(java.lang.String theObjectType)

Set the object's type

Parameters:

theObjectType - The type of the object. "P" for a science object. "F" for a fiducial object. "S" for a sky object.

setFiducialObject

void setFiducialObject()

Set the object type as a fiducial object

setScienceObject

void setScienceObject()

Set the object type as a science object

setWeight

void setWeight(double theObjectWeight)

Set the weighting value of the object

Parameters:

theObjectWeight - The weighting value of the object

setMagnitude

void setMagnitude(double theObjectMagnitude)

Set the object's magnitude

Parameters:

theObjectMagnitude - The magnitude of the object

setIdentity

void setIdentity(java.lang.String theObjectIdentity)

Set the identity of the object

Parameters:

theObjectIdentity - The identity of the object

getRa

java.lang.String getRa()

Get the RA of the object

Returns:

The RA of the object

getDec

java.lang.String getDec()

Get the declination of the object

Returns:

The declination of the object

getMagnitude

double getMagnitude()

Get the magnitude

Returns:

The magnitude

getName

java.lang.String getName()

Get the name of the object

Returns:

The name of the object

getType

java.lang.String getType()

Return the object's type

Returns:

The object type

getWeight

double getWeight()

Return the object's weighting

Returns:

The object's weighting

isScienceObject

boolean isScienceObject()

Is the object a science object type

Returns:

Boolean to indicate whether the object is a science object

isFiducialObject

boolean isFiducialObject()

Is the object a fiducial object type

Returns:

Boolean to indicate whether the object is a fiducial object

toString

public java.lang.String toString()

Returns a string representation of the object

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the object