vega.uplink.commanding

Class Por

java.lang.Object

MapContext

vega.hipe.products.AbstractXmlMapContext

vega.uplink.commanding.Por

All Implemented Interfaces:

XmlDataInterface, SequenceTimelineInterface

Direct Known Subclasses:

ObservationPor, SuperPor

public class Por
extends AbstractXmlMapContext
implements SequenceTimelineInterface

Class to store a Payload Operation Request (POR), is a set of sequences to be executed at the spacecraft

Constructor Summary

Constructors

Constructor and Description
Por()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSequence(SequenceInterface sequence) Add a sequence to the timeline
protected void	calculateValidity()
Por	copy()
AbstractSequence[]	findOverlapingSequences(java.util.Date startDate, java.util.Date endDate) get all sequences with execution date in range of dates
java.lang.String	getFileName() Get the file name where this object is or will be stored
java.util.Date	getGenerationDate() Get the genration date of the POR
java.lang.String	getGenerationTime() Get teh generation date of the POR as string in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')
String1d	getInitDataStore() In the case that the POR has been loaded form an ITL, get the itl lines to init the data store
String1d	getInitMemory() In the case that the POR has been loaded form an ITL, get the itl lines to init the memory
String1d	getInitModes() In the case that the POR has been loaded form an ITL, get the itl lines to init the modes
String1d	getInitMS() In the case that the POR has been loaded form an ITL, get the itl lines to init the MS
java.lang.String	getName() Get the name of the timeline
AbstractSequence[]	getOrderedSequences() Get all sequences in this timeline in execution time order
java.lang.String	getPath() Get the path where this object is or will be stored
Por	getPORforInstrument(java.lang.String instrument) Get a POR with the sequences for a given instrument
AbstractSequence	getSequenceBefore(java.util.Date date) Get all sequences before a date
AbstractSequence[]	getSequences() Get the sequences in this timeline
AbstractSequence[]	getSequencesForDate(java.util.Date date) Get the sequences with a given execution date
Por	getSubPor(java.util.Date startDate, java.util.Date endDate) Get a subpor with all sequences from a date to a date
Por	getSubPor(java.lang.String instrument) Get a subpor with all sequences from a given instrument
java.util.Date[]	getValidityDates() Get the validity dates for this POR
java.lang.String[]	getValidityTimes() Get the validity dates for this POR as strings in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')
java.lang.String	getVersion() Get the version of the POR
java.lang.String	getXmlData() Get the XML text representing this object
protected org.w3c.dom.Document	getXMLDocument()
protected AbstractSequence[]	insertInOrder(AbstractSequence[] arr, AbstractSequence newSeq)
protected AbstractSequence[]	insertSequenceAt(AbstractSequence[] arr, AbstractSequence newSeq, int index)
void	regenerate(Por por) Regenerate a POR form another oen.
void	removeAllSequences() Remove all sequences form the POR
void	removeSequence(SequenceInterface sequence) Remove a sequence from the POR.
void	save() Save this object into a file.
void	saveAs(java.lang.String file) Save this object into a file with the give file name
void	setCalculateValidity(boolean recalcualte) Set it to True if the validity of the POR should be recalculated for any new sequence added or false otherwise
void	setFileName(java.lang.String newFileName) Set the file name where this object is or will be stored
void	setGenerationDate(java.util.Date date) Set the generation date of a POR
void	setGenerationTime(java.lang.String time) Set the generation date of the POR as String in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')
void	setInitDataStore(String1d ims) In the case that the POR has been loaded form an ITL, set the itl lines to init the data store
void	setInitMemory(String1d ims) In the case that the POR has been loaded form an ITL, set the itl lines to init the memory
void	setInitModes(String1d im) In the case that the POR has been loaded form an ITL, set the itl lines to init the modes
void	setInitMS(String1d ims) In the case that the POR has been loaded form an ITL, set the itl lines to init the MS
void	setName(java.lang.String name) Set the name of the timeline
void	setPath(java.lang.String path) Set the path where this object is or will be stored
void	setSequences(SequenceInterface[] porSequences) Remove any sequences to this timeline and add the given sequences
void	setValidityDates(java.util.Date[] dates) Set the validity dates for this POR.
void	setValidityTimes(java.lang.String[] times) Set the validity dates for this POR as strings in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')
void	setVersion(java.lang.String version) Set the version of the POR
void	setXmlData(java.lang.String data) Set the XML text representing this object
java.lang.String	toXml() Get a XML representation of this timeline

Methods inherited from class java.lang.Object

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

Constructor Detail

Por

public Por()

Method Detail

copy

public Por copy()

getInitModes

public String1d getInitModes()

In the case that the POR has been loaded form an ITL, get the itl lines to init the modes

Returns:

getInitMS

public String1d getInitMS()

In the case that the POR has been loaded form an ITL, get the itl lines to init the MS

Returns:

getInitMemory

public String1d getInitMemory()

In the case that the POR has been loaded form an ITL, get the itl lines to init the memory

Returns:

getInitDataStore

public String1d getInitDataStore()

In the case that the POR has been loaded form an ITL, get the itl lines to init the data store

Returns:

setInitModes

public void setInitModes(String1d im)

In the case that the POR has been loaded form an ITL, set the itl lines to init the modes

Parameters:

im -

setInitMS

public void setInitMS(String1d ims)

In the case that the POR has been loaded form an ITL, set the itl lines to init the MS

Parameters:

ims -

setInitMemory

public void setInitMemory(String1d ims)

In the case that the POR has been loaded form an ITL, set the itl lines to init the memory

Parameters:

ims -

setInitDataStore

public void setInitDataStore(String1d ims)

In the case that the POR has been loaded form an ITL, set the itl lines to init the data store

Parameters:

ims -

setName

public void setName(java.lang.String name)

Description copied from interface: SequenceTimelineInterface

Set the name of the timeline

Specified by:

setName in interface SequenceTimelineInterface

setPath

public void setPath(java.lang.String path)

Description copied from interface: XmlDataInterface

Set the path where this object is or will be stored

Specified by:

setPath in interface XmlDataInterface

getName

public java.lang.String getName()

Description copied from interface: SequenceTimelineInterface

Get the name of the timeline

Specified by:

getName in interface SequenceTimelineInterface

Returns:

setVersion

public void setVersion(java.lang.String version)

Set the version of the POR

Parameters:

version -

getVersion

public java.lang.String getVersion()

Get the version of the POR

Returns:

getPath

public java.lang.String getPath()

Description copied from interface: XmlDataInterface

Get the path where this object is or will be stored

Specified by:

getPath in interface XmlDataInterface

Returns:

addSequence

public void addSequence(SequenceInterface sequence)

Description copied from interface: SequenceTimelineInterface

Add a sequence to the timeline

Specified by:

addSequence in interface SequenceTimelineInterface

removeSequence

public void removeSequence(SequenceInterface sequence)

Remove a sequence from the POR. The sequence that will removed will be the one with the same UniqueID as the one passed

Parameters:

sequence -

removeAllSequences

public void removeAllSequences()

Remove all sequences form the POR

regenerate

public void regenerate(Por por)

Regenerate a POR form another oen. It will remove all sequences from this POR and add the sequences from the given one, keeping the rest of the metadata as it is in this one.

Parameters:

por -

setCalculateValidity

public void setCalculateValidity(boolean recalcualte)

Set it to True if the validity of the POR should be recalculated for any new sequence added or false otherwise

Parameters:

recalcualte -

calculateValidity

protected void calculateValidity()

getSequencesForDate

public AbstractSequence[] 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:

getSubPor

public Por getSubPor(java.util.Date startDate,
            java.util.Date endDate)

Get a subpor with all sequences from a date to a date

Parameters:

startDate -

endDate -

Returns:

getSubPor

public Por getSubPor(java.lang.String instrument)

Get a subpor with all sequences from a given instrument

Parameters:

instrument -

Returns:

findOverlapingSequences

public AbstractSequence[] findOverlapingSequences(java.util.Date startDate,
                                         java.util.Date endDate)

get all sequences with execution date in range of dates

Parameters:

startDate -

endDate -

Returns:

setGenerationDate

public void setGenerationDate(java.util.Date date)

Set the generation date of a POR

Parameters:

date -

setGenerationTime

public void setGenerationTime(java.lang.String time)
                       throws java.text.ParseException

Set the generation date of the POR as String in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')

Parameters:

time -

Throws:

java.text.ParseException

getGenerationDate

public java.util.Date getGenerationDate()

Get the genration date of the POR

Returns:

getGenerationTime

public java.lang.String getGenerationTime()

Get teh generation date of the POR as string in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')

Returns:

getValidityDates

public java.util.Date[] getValidityDates()

Get the validity dates for this POR

Returns:

an array of size 2 where the element 0 is the start date and element 1 is the end date

setValidityDates

public void setValidityDates(java.util.Date[] dates)

Set the validity dates for this POR.

Parameters:

dates - n array of size 2 where the element 0 is the start date and element 1 is the end date

setValidityTimes

public void setValidityTimes(java.lang.String[] times)
                      throws java.text.ParseException

Set the validity dates for this POR as strings in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')

Parameters:

times - an array of size 2 where the element 0 is the start date and element 1 is the end date

Throws:

java.text.ParseException

getValidityTimes

public java.lang.String[] getValidityTimes()

Get the validity dates for this POR as strings in DOY format (yyyy-D'T'HH:mm:ss.SSS'Z')

Returns:

an array of size 2 where the element 0 is the start date and element 1 is the end date

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

getSequences

public AbstractSequence[] getSequences()

Description copied from interface: SequenceTimelineInterface

Get the sequences in this timeline

Specified by:

getSequences in interface SequenceTimelineInterface

Returns:

getXMLDocument

protected org.w3c.dom.Document getXMLDocument()
                                       throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

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 AbstractSequence[] getOrderedSequences()

Description copied from interface: SequenceTimelineInterface

Get all sequences in this timeline in execution time order

Specified by:

getOrderedSequences in interface SequenceTimelineInterface

Returns:

insertInOrder

protected AbstractSequence[] insertInOrder(AbstractSequence[] arr,
                               AbstractSequence newSeq)

insertSequenceAt

protected AbstractSequence[] insertSequenceAt(AbstractSequence[] arr,
                                  AbstractSequence newSeq,
                                  int index)

getSequenceBefore

public AbstractSequence getSequenceBefore(java.util.Date date)

Description copied from interface: SequenceTimelineInterface

Get all sequences before a date

Specified by:

getSequenceBefore in interface SequenceTimelineInterface

Returns:

getPORforInstrument

public Por getPORforInstrument(java.lang.String instrument)

Get a POR with the sequences for a given instrument

Parameters:

instrument -

Returns:

getXmlData

public java.lang.String getXmlData()

Description copied from interface: XmlDataInterface

Get the XML text representing this object

Specified by:

getXmlData in interface XmlDataInterface

Returns:

setFileName

public void setFileName(java.lang.String newFileName)

Description copied from interface: XmlDataInterface

Set the file name where this object is or will be stored

Specified by:

setFileName in interface XmlDataInterface

getFileName

public java.lang.String getFileName()

Description copied from interface: XmlDataInterface

Get the file name where this object is or will be stored

Specified by:

getFileName in interface XmlDataInterface

Returns:

setXmlData

public void setXmlData(java.lang.String data)

Description copied from interface: XmlDataInterface

Set the XML text representing this object

Specified by:

setXmlData in interface XmlDataInterface

saveAs

public void saveAs(java.lang.String file)
            throws java.io.FileNotFoundException,
                   java.io.UnsupportedEncodingException

Description copied from interface: XmlDataInterface

Save this object into a file with the give file name

Specified by:

saveAs in interface XmlDataInterface

Parameters:

file - Complete path where to save the file

Throws:

java.io.FileNotFoundException

java.io.UnsupportedEncodingException

save

public void save()
          throws java.io.FileNotFoundException,
                 java.io.UnsupportedEncodingException

Description copied from interface: XmlDataInterface

Save this object into a file.

Specified by:

save in interface XmlDataInterface

Throws:

java.io.FileNotFoundException

java.io.UnsupportedEncodingException