org.das2.datum

Class OrbitDatumRange

java.lang.Object

org.das2.datum.DatumRange

org.das2.datum.OrbitDatumRange

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class OrbitDatumRange
extends DatumRange
implements java.io.Serializable

DatumRange implementation that identifies times by orbit number. Note orbit numbers are strings, see Cassini for why. next will return the same one at the end of the sequence. dr= new OrbitDatumRange( "crres", "6" ) dr.toString() → "orbit:crres:6" dr= dr.next() dr.toString() → "orbit:crres:7" Also, orbit:http://das2.org/wiki/index.php/Orbits/crres:6 is supported for development work and personal lists.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OrbitDatumRange(java.lang.String sc, java.lang.String orbit)
OrbitDatumRange(java.lang.String sc, java.lang.String orbit, Units unitPref)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compare this to another DatumRange, ordered by the lesser datum, then the greater datum.
DatumRange	convertTo(Units u) return this DatumRange in new units.
boolean	equals(java.lang.Object o) returns true if the two endpoints are equal.
java.lang.String	getOrbit() return the string identifying this orbit, assuming the context is provided elsewhere.
java.lang.String	getSpacecraft() return the spacecraft for the orbits, which can be a reference to a 3-column file.
int	hashCode()
static OrbitDatumRange	maybeRelativize(java.lang.String pwd, OrbitDatumRange odr)
static OrbitDatumRange	maybeRelativize(java.lang.String pwd, OrbitDatumRange odr, java.lang.String extraFormat) return a special OrbitDatumRange which contains metadata which will allow it to be represented as %{PWD}orbit.dat, so that .vap files can use resources relative to the .vap.These should not be used outside of this context, but doing so is harmless.
DatumRange	next() returns the next DatumRange covering the space defined by Units.
DatumRange	previous() returns the previous DatumRange covering the space defined by Units.
void	setCheat(java.lang.String cheat) add subdirectory to %{PWD} when formatting, so we can embed the orbits file in a zip file under a "cheat" directory.
java.lang.String	toString() returns a human consumable representation of the string.

Methods inherited from class org.das2.datum.DatumRange

contains, contains, getUnits, include, intersection, intersects, max, middle, min, newDatumRange, newRange, newRange, newRange, rescale, union, width, zoomOut

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitDatumRange

public OrbitDatumRange(java.lang.String sc,
                       java.lang.String orbit)
                throws java.text.ParseException

Throws:

java.text.ParseException

OrbitDatumRange

public OrbitDatumRange(java.lang.String sc,
                       java.lang.String orbit,
                       Units unitPref)
                throws java.text.ParseException

Throws:

java.text.ParseException

Method Detail

maybeRelativize

public static OrbitDatumRange maybeRelativize(java.lang.String pwd,
                                              OrbitDatumRange odr,
                                              java.lang.String extraFormat)
                                       throws java.io.IOException

return a special OrbitDatumRange which contains metadata which will allow it to be represented as %{PWD}orbit.dat, so that .vap files can use resources relative to the .vap.These should not be used outside of this context, but doing so is harmless.

Parameters:

pwd - the absolute position

odr - the OrbitDatumRange to be relativized.

extraFormat - extra directory that will be used when saved.

Returns:

either the original OrbitDatumRange, or a new relative one, which will serialize to "orbit:%{PWD}orbit.dat".

Throws:

java.io.IOException

maybeRelativize

public static OrbitDatumRange maybeRelativize(java.lang.String pwd,
                                              OrbitDatumRange odr)
                                       throws java.io.IOException

Throws:

java.io.IOException

setCheat

public void setCheat(java.lang.String cheat)

add subdirectory to %{PWD} when formatting, so we can embed the orbits file in a zip file under a "cheat" directory. Though this is public, it should not be used unless you thoroughly understand why this was done.

Parameters:

cheat -

next

public DatumRange next()

Description copied from class: DatumRange

returns the next DatumRange covering the space defined by Units. Typically, this will be a range with a min equal to this datum's max, and the same width. Some implementations of DatumRange may return a range with a different width than this DatumRange's width, for example, when advancing month-by-month with a MonthDatumRange. When there is no next interval, then this same range will be returned.

Overrides:

next in class DatumRange

Returns:

the next DatumRange covering the space defined by Units.

previous

public DatumRange previous()

Description copied from class: DatumRange

returns the previous DatumRange covering the space defined by Units. See next(). When there is no previous interval, then this same range will be returned.

Overrides:

previous in class DatumRange

Returns:

the previous DatumRange covering the space defined by Units

convertTo

public DatumRange convertTo(Units u)

Description copied from class: DatumRange

return this DatumRange in new units. Note this may cause some functions of a DatumRange to change, such as the next() for a MonthDatumRange, but implementations should attempt to preserve type.

Overrides:

convertTo in class DatumRange

Parameters:

u - the new units.

Returns:

the DatumRange in the new units.

compareTo

public int compareTo(java.lang.Object o)

Description copied from class: DatumRange

Compare this to another DatumRange, ordered by the lesser datum, then the greater datum. This is mostly provided for .equals, but also so there is a consistent ordering convention though out the system.

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class DatumRange

Parameters:

o - the DatumRange to compare this DatumRange to.

Returns:

an int < 0 if this comes before DatumRange a in this DatumRange's units space, 0 if they are equal, and > 0 otherwise.

equals

public boolean equals(java.lang.Object o)

Description copied from class: DatumRange

returns true if the two endpoints are equal.

Overrides:

equals in class DatumRange

hashCode

public int hashCode()

Overrides:

hashCode in class DatumRange

getOrbit

public java.lang.String getOrbit()

return the string identifying this orbit, assuming the context is provided elsewhere. For example, supposing this toString() is "orbit:rbspa-pp:43" then this would return just "43"

Returns:

the string providing the orbit.

getSpacecraft

public java.lang.String getSpacecraft()

return the spacecraft for the orbits, which can be a reference to a 3-column file.

Returns:

the spacecraft id.

toString

public java.lang.String toString()

Description copied from class: DatumRange

returns a human consumable representation of the string. This should also be parsable with DatumRangeUtil.parseDatumRange, but this has not been verified to complete certainty.

Overrides:

toString in class DatumRange

Returns:

the DatumRange as a String.