net.grelf.astro

Class Magnitude

java.lang.Object

net.grelf.astro.Magnitude

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Magnitude
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Type representing astronomical magnitude. NB: If a star's magnitude is unknown that fact is represented by having a null magnitude. There is no Magnitude object having unknown value. Designed in such a way that band ids can be ignored if desired. A band id can be any string of text but the conventional single-character identifiers (I, B, V, R, etc) may be used.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Magnitude(float value) Unknown band - bandId set to empty string.
Magnitude(float value, float sigma) Unknown band - bandId set to empty string.
Magnitude(float value, float sigma, java.lang.String bandId) Band identifier is typically a single letter: U, B, V, R or I.
Magnitude(float value, java.lang.String bandId) Band identifier is typically a single letter: U, B, V, R or I.
Magnitude(MeasuredValue mv, java.lang.String bandId) Band identifier is typically a single letter: U, B, V, R or I.

Method Summary

Modifier and Type	Method and Description
Magnitude	clone() Returns a new Magnitude object with the same data.
boolean	equals(java.lang.Object other)
java.lang.String	getBandId() Get band identifier, typically a single letter: U, B, V, R or I.
float	getSigma()
float	getValue()
int	hashCode() Enable objects of this class to be used as hash keys.
java.lang.String	toString()
java.lang.StringBuffer	toXML() Creates a <Mag> element, either containing a simple value (if the band id is empty) or 2 sub-elements: <Band> and <Value>.

Methods inherited from class java.lang.Object

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

Constructor Detail

Magnitude

public Magnitude(float value)

Unknown band - bandId set to empty string.

Magnitude

public Magnitude(float value,
                 float sigma)

Unknown band - bandId set to empty string.

Magnitude

public Magnitude(float value,
                 java.lang.String bandId)

Band identifier is typically a single letter: U, B, V, R or I.

Magnitude

public Magnitude(float value,
                 float sigma,
                 java.lang.String bandId)

Band identifier is typically a single letter: U, B, V, R or I.

Magnitude

public Magnitude(MeasuredValue mv,
                 java.lang.String bandId)

Band identifier is typically a single letter: U, B, V, R or I.

Method Detail

getValue

public float getValue()

getSigma

public float getSigma()

getBandId

public java.lang.String getBandId()

Get band identifier, typically a single letter: U, B, V, R or I.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Enable objects of this class to be used as hash keys.

Overrides:

hashCode in class java.lang.Object

clone

public Magnitude clone()

Returns a new Magnitude object with the same data.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXML

public java.lang.StringBuffer toXML()

Creates a <Mag> element, either containing a simple value (if the band id is empty) or 2 sub-elements: <Band> and <Value>.