vega.uplink.planning

Class Observation

java.lang.Object

MapContext

vega.uplink.planning.Observation

All Implemented Interfaces:

java.lang.Comparable<Observation>, SequenceTimelineInterface, PointingBlockSetInterface

Direct Known Subclasses:

Itl

public class Observation
extends MapContext
implements PointingBlockSetInterface, SequenceTimelineInterface, java.lang.Comparable<Observation>

An Observation defines an activity of the spacecraft both in pointing and commanding. All commands and pointing blocks times are relative to events, the start observation event and the end observation event. This allows to move the observation in the timeline and all the pointing blocks and command sequences will move with it.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.SortedMap<java.lang.String,java.util.Date>	eventMap
static boolean	LISTEN

Constructor Summary

Constructors

Constructor and Description
Observation(java.util.Date startDate, java.util.Date endDate) Creates an Observation with a start time and end time

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(PointingBlockInterface newBlock) Add a new block to the given segment
void	addEvent(ObservationEvent event, java.util.Date date) Add an ebent to the list of events that can be used in this observation.
void	addObservationBlock(ObservationPointingBlock newBlock) Add a pointiong block tho this Observation
void	addObservationListener(ObservationListener newListener) Add a listener to the changes of this Observation
void	addObservationSequence(ObservationSequence sequence) Add a Sequernce to this Observation
void	addSequence(SequenceInterface sequence) Add a sequence to the timeline
PointingBlockInterface	blockAfter(PointingBlockInterface block)
PointingBlockInterface	blockBefore(PointingBlockInterface block) Get the block before the one given (before the start time the block), or null if there is no block before this one
protected void	commandingChange( source)
int	compareTo(Observation o)
Observation	copy()
protected void	fireChange( source)
PointingBlockSetInterface	getAllBlocksOfType(java.lang.String blockType) Get all blocks of a given type
PointingBlock	getBlockAt(java.util.Date time) Get the block with a start time equal to the given one or the greates value before the given date
PointingBlockInterface[]	getBlocks() Get all the blocks in this segment
PointingBlockSetInterface	getBlocksAt(java.util.Date startTime, java.util.Date endTime)
Por	getCommanding() Get the commanding part of this Observation
java.util.Date	getDateForEvent(ObservationEvent event) Get teh actual date for an event
static Observation	getDefaultObservation() Static method that allows to create an Observation with start time equals to th ecurrent time and the end time one hour after.
ObservationEvent[]	getDefinedEvents() Get all the events defined for this observation
long	getDurationMilliSecs() Get the duration of this observation in milliseconds
java.lang.String	getFileName() Get the filename desired for the file holding this Observation
java.lang.String	getName() Get the name of this segment
java.util.Date	getObsEndDate() Get the end time of this Observation
java.util.Date	getObsStartDate() Get the start time of this observation
SequenceInterface[]	getOrderedSequences() Get all sequences in this timeline in execution time order
java.lang.String	getPath() Set the desired path when saving this Observation
PointingBlocksSlice	getPointing() Get the pointing part of this Observation
SequenceInterface	getSequenceBefore(java.util.Date date) Get all sequences before a date
SequenceInterface[]	getSequences() Get the sequences in this timeline
SequenceInterface[]	getSequencesForDate(java.util.Date date) Get the sequences with a given execution date
void	metaChange( source)
protected void	pointingChange( source)
void	regenerate(Observation obs)
void	regenerate(PointingBlockSetInterface slice)
void	removeBlock(PointingBlockInterface block) Remove a block from the segment.
void	removeBlocks(PointingBlock[] blocks)
void	removeEvent(ObservationEvent event) Remove an event from the list of events that can be used in this observation
void	removeObservationListener(ObservationListener listener) Remove a listener to the changes in this Observation
void	setBlocks(PointingBlockInterface[] newBlocks) Remove all currents blocks and substitute by the given ones
void	setCommanding(ObservationPor por) Set the commanding part of the observation
void	setEventMap(java.util.SortedMap<java.lang.String,java.util.Date> map)
void	setFileName(java.lang.String fileName) Set the file name that will be used when this Observation will be saved to a file
void	setName(java.lang.String newName) Set or replace the name of this segment
void	setObsEndDate(java.util.Date date) Set the end time of this Observation
void	setObservationBlocks(ObservationPointingBlock[] newBlocks) Set the pointing blocks of this Observation
void	setObservationSequences(ObservationSequence[] porSequences) Set the sequences of this Observation
void	setObservationSlice(Observation slice) Merge to Observations (on the pointing)
void	setObsStartDate(java.util.Date date) Set the start time of this Observation
void	setPath(java.lang.String path) Set the desired path when saving this Observation
void	setPointing(ObservationPointingSlice slice) Set the pointing part of an Observation
void	setSequences(SequenceInterface[] porSequences) Remove any sequences to this timeline and add the given sequences
void	setSlice(PointingBlockSetInterface slice)
void	shiftEvent(ObservationEvent event, long delta) Shift an event defined for this observation a number of milliseconds
java.lang.String	toItl() Get a string with the commanding part of the observation in ITL format
java.lang.String	toString()
java.lang.String	toXml() Get a XML representation of this timeline
java.lang.String	toXml(int indent) Get the XML representation of this segment as per FD ICD

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

LISTEN

public static boolean LISTEN

eventMap

public java.util.SortedMap<java.lang.String,java.util.Date> eventMap

Constructor Detail

Observation

public Observation(java.util.Date startDate,
           java.util.Date endDate)

Creates an Observation with a start time and end time

Parameters:

startDate -

endDate -

Method Detail

setEventMap

public void setEventMap(java.util.SortedMap<java.lang.String,java.util.Date> map)

setFileName

public void setFileName(java.lang.String fileName)

Set the file name that will be used when this Observation will be saved to a file

Parameters:

fileName -

getDefaultObservation

public static Observation getDefaultObservation()

Static method that allows to create an Observation with start time equals to th ecurrent time and the end time one hour after. The POinting will be defines as power optimized.

Returns:

Default Observation

addObservationListener

public void addObservationListener(ObservationListener newListener)

Add a listener to the changes of this Observation

Parameters:

newListener -

removeObservationListener

public void removeObservationListener(ObservationListener listener)

Remove a listener to the changes in this Observation

Parameters:

listener -

addEvent

public void addEvent(ObservationEvent event,
            java.util.Date date)

Add an ebent to the list of events that can be used in this observation. Only the events START_OBS, END OBS and the ones added via this method can be used in the observation

Parameters:

event - The event to be added

date - The date co-related to this event

removeEvent

public void removeEvent(ObservationEvent event)

Remove an event from the list of events that can be used in this observation

Parameters:

event -

fireChange

protected void fireChange( source)

metaChange

public void metaChange( source)

commandingChange

protected void commandingChange( source)

pointingChange

protected void pointingChange( source)

getFileName

public java.lang.String getFileName()

Get the filename desired for the file holding this Observation

Returns:

copy

public Observation copy()

getDurationMilliSecs

public long getDurationMilliSecs()

Get the duration of this observation in milliseconds

Returns:

regenerate

public void regenerate(Observation obs)

setName

public void setName(java.lang.String newName)

Description copied from interface: PointingBlockSetInterface

Set or replace the name of this segment

Specified by:

setName in interface SequenceTimelineInterface

Specified by:

setName in interface PointingBlockSetInterface

getName

public java.lang.String getName()

Description copied from interface: PointingBlockSetInterface

Get the name of this segment

Specified by:

getName in interface SequenceTimelineInterface

Specified by:

getName in interface PointingBlockSetInterface

Returns:

name of the segment

getObsStartDate

public java.util.Date getObsStartDate()

Get the start time of this observation

Returns:

getObsEndDate

public java.util.Date getObsEndDate()

Get the end time of this Observation

Returns:

setObsStartDate

public void setObsStartDate(java.util.Date date)

Set the start time of this Observation

Parameters:

date -

setObsEndDate

public void setObsEndDate(java.util.Date date)

Set the end time of this Observation

Parameters:

date -

getCommanding

public Por getCommanding()

Get the commanding part of this Observation

Returns:

setPointing

public void setPointing(ObservationPointingSlice slice)

Set the pointing part of an Observation

Parameters:

slice - The blocks defining the pointing for the observation

setCommanding

public void setCommanding(ObservationPor por)

Set the commanding part of the observation

Parameters:

por - The sequences defining the commanding part of the observation

getPointing

public PointingBlocksSlice getPointing()

Get the pointing part of this Observation

Returns:

addSequence

public void addSequence(SequenceInterface sequence)

Description copied from interface: SequenceTimelineInterface

Add a sequence to the timeline

Specified by:

addSequence in interface SequenceTimelineInterface

addObservationSequence

public void addObservationSequence(ObservationSequence sequence)

Add a Sequernce to this Observation

Parameters:

sequence -

getSequencesForDate

public SequenceInterface[] getSequencesForDate(java.util.Date date)

Description copied from interface: SequenceTimelineInterface

Get the sequences with a given execution date

Specified by:

getSequencesForDate in interface SequenceTimelineInterface

Returns:

setSequences

public void setSequences(SequenceInterface[] porSequences)

Description copied from interface: SequenceTimelineInterface

Remove any sequences to this timeline and add the given sequences

Specified by:

setSequences in interface SequenceTimelineInterface

setObservationSequences

public void setObservationSequences(ObservationSequence[] porSequences)

Set the sequences of this Observation

Parameters:

porSequences -

getSequences

public SequenceInterface[] getSequences()

Description copied from interface: SequenceTimelineInterface

Get the sequences in this timeline

Specified by:

getSequences in interface SequenceTimelineInterface

Returns:

toXml

public java.lang.String toXml()

Description copied from interface: SequenceTimelineInterface

Get a XML representation of this timeline

Specified by:

toXml in interface SequenceTimelineInterface

Returns:

getOrderedSequences

public SequenceInterface[] getOrderedSequences()

Description copied from interface: SequenceTimelineInterface

Get all sequences in this timeline in execution time order

Specified by:

getOrderedSequences in interface SequenceTimelineInterface

Returns:

getSequenceBefore

public SequenceInterface getSequenceBefore(java.util.Date date)

Description copied from interface: SequenceTimelineInterface

Get all sequences before a date

Specified by:

getSequenceBefore in interface SequenceTimelineInterface

Returns:

regenerate

public void regenerate(PointingBlockSetInterface slice)

Specified by:

regenerate in interface PointingBlockSetInterface

removeBlock

public void removeBlock(PointingBlockInterface block)

Description copied from interface: PointingBlockSetInterface

Remove a block from the segment. It adjust as well the slews if they are affected by the removal.

Specified by:

removeBlock in interface PointingBlockSetInterface

Parameters:

block - Block to be removed

blockBefore

public PointingBlockInterface blockBefore(PointingBlockInterface block)

Description copied from interface: PointingBlockSetInterface

Get the block before the one given (before the start time the block), or null if there is no block before this one

Specified by:

blockBefore in interface PointingBlockSetInterface

Returns:

blockAfter

public PointingBlockInterface blockAfter(PointingBlockInterface block)

Specified by:

blockAfter in interface PointingBlockSetInterface

addBlock

public void addBlock(PointingBlockInterface newBlock)

Description copied from interface: PointingBlockSetInterface

Add a new block to the given segment

Specified by:

addBlock in interface PointingBlockSetInterface

Parameters:

newBlock - Block to be added

addObservationBlock

public void addObservationBlock(ObservationPointingBlock newBlock)

Add a pointiong block tho this Observation

Parameters:

newBlock -

getBlocks

public PointingBlockInterface[] getBlocks()

Description copied from interface: PointingBlockSetInterface

Get all the blocks in this segment

Specified by:

getBlocks in interface PointingBlockSetInterface

Returns:

Array with all the blocks in this segment

setBlocks

public void setBlocks(PointingBlockInterface[] newBlocks)

Description copied from interface: PointingBlockSetInterface

Remove all currents blocks and substitute by the given ones

Specified by:

setBlocks in interface PointingBlockSetInterface

Parameters:

newBlocks - New blocks to replace the current ones

setObservationBlocks

public void setObservationBlocks(ObservationPointingBlock[] newBlocks)

Set the pointing blocks of this Observation

Parameters:

newBlocks -

toXml

public java.lang.String toXml(int indent)

Description copied from interface: PointingBlockSetInterface

Get the XML representation of this segment as per FD ICD

Specified by:

toXml in interface PointingBlockSetInterface

Parameters:

indent - the Number of tabs to be added before each line

Returns:

The XML representation of this segment

toItl

public java.lang.String toItl()

Get a string with the commanding part of the observation in ITL format

Returns:

getBlockAt

public PointingBlock getBlockAt(java.util.Date time)

Description copied from interface: PointingBlockSetInterface

Get the block with a start time equal to the given one or the greates value before the given date

Specified by:

getBlockAt in interface PointingBlockSetInterface

Parameters:

time - The desired time

Returns:

The block with a start time less or equal to the given time or null if there is no such block

getBlocksAt

public PointingBlockSetInterface getBlocksAt(java.util.Date startTime,
                                    java.util.Date endTime)

Specified by:

getBlocksAt in interface PointingBlockSetInterface

removeBlocks

public void removeBlocks(PointingBlock[] blocks)

Specified by:

removeBlocks in interface PointingBlockSetInterface

getAllBlocksOfType

public PointingBlockSetInterface getAllBlocksOfType(java.lang.String blockType)

Description copied from interface: PointingBlockSetInterface

Get all blocks of a given type

Specified by:

getAllBlocksOfType in interface PointingBlockSetInterface

Parameters:

blockType - type of blocks to search for

Returns:

an array of blocks of the given type

setSlice

public void setSlice(PointingBlockSetInterface slice)

Specified by:

setSlice in interface PointingBlockSetInterface

setObservationSlice

public void setObservationSlice(Observation slice)

Merge to Observations (on the pointing)

Parameters:

slice -

getDateForEvent

public java.util.Date getDateForEvent(ObservationEvent event)

Get teh actual date for an event

Parameters:

event -

Returns:

getDefinedEvents

public ObservationEvent[] getDefinedEvents()

Get all the events defined for this observation

Returns:

setPath

public void setPath(java.lang.String path)

Set the desired path when saving this Observation

Parameters:

path -

getPath

public java.lang.String getPath()

Set the desired path when saving this Observation

Returns:

shiftEvent

public void shiftEvent(ObservationEvent event,
              long delta)

Shift an event defined for this observation a number of milliseconds

Parameters:

event - The event to be shifted

delta - The number of milliseconds to shift

toString

public java.lang.String toString()

compareTo

public int compareTo(Observation o)