vega.uplink.commanding

Class Orcd

java.lang.Object

TableDataset

vega.uplink.commanding.Orcd

public class Orcd
extends TableDataset

Implementation of the Operations Rules and Constrains Document. It is the model of the spacecraft, defining what sequence is allowed, the mode transitions and the power consumed by the different modes

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_ALLOWED The index in the table for the ALLOWED column.
static int	INDEX_MODE The index in the table for the MODE column.
static int	INDEX_NOT_ALLOWED The index in the table for the NOT ALLOWED column.
static int	INDEX_OFFSET The index in the table for the OFFSET column.
static int	INDEX_POWER The index in the table for the POWER column.
static int	INDEX_SEQUENCE The index in the table for the SEQUENCE column.

Method Summary

Methods

Modifier and Type	Method and Description
herschel.ia.dataset.TableDataset	asTable()
boolean	checkTransion(java.lang.String mode1, java.lang.String mode2) Check if transition from a mode to another is allowed in the ORCD
java.util.HashMap<java.lang.Long,java.lang.String>	getModes(java.lang.String sequence) Get the modes and times that a sequence will trigger
java.util.HashMap<java.lang.Long,java.lang.String>	getModesAsHistory(AbstractSequence sequence) Get the times and the modes that a sequence will trigger.
java.util.HashMap<java.lang.Long,java.lang.String>	getModesAsHistory(java.lang.String sequence, java.util.Date initialTime) Get the times and the modes that a sequence will trigger.
java.util.HashMap<java.lang.Long,java.lang.String>	getModesAsHistory(java.lang.String sequence, long initialTime) Get the times and the modes that a sequence will trigger.
static Orcd	getOrcd() Get the ORCD.
float	getPowerForMode(java.lang.String mode) Get the power defined in the ORCD for a given mode
float	getTotalPowerForModes(java.lang.String[] modes) Get the total power for a list of modes (just the sum of the power defined for each mode)
java.lang.String	getVersion() Get the version of the ORCD
static Orcd	readORCDXmlfile(java.lang.String xmlFile) Read the ORCD from a XML file
static Orcd	readORCDXmlfromJar() Read the XML from a jar file in the class path.
void	setVersion(java.lang.String version) Set the version of the ORCD
java.lang.String	toXml() Get a XML representation of the ORCD
void	writeToXmlFile(java.lang.String file) Write the ORCD representation to a XML file

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_MODE

public static int INDEX_MODE

The index in the table for the MODE column. 0

INDEX_POWER

public static int INDEX_POWER

The index in the table for the POWER column. 1

INDEX_SEQUENCE

public static int INDEX_SEQUENCE

The index in the table for the SEQUENCE column. 2

INDEX_OFFSET

public static int INDEX_OFFSET

The index in the table for the OFFSET column. 3

INDEX_ALLOWED

public static int INDEX_ALLOWED

The index in the table for the ALLOWED column. 4

INDEX_NOT_ALLOWED

public static int INDEX_NOT_ALLOWED

The index in the table for the NOT ALLOWED column. 5

Method Detail

getOrcd

public static Orcd getOrcd()

Get the ORCD. It tries first to get it form the XML file as defined in the properties, then it will try to read it from the jars files present in the class path

Returns:

setVersion

public void setVersion(java.lang.String version)

Set the version of the ORCD

Parameters:

version -

getVersion

public java.lang.String getVersion()

Get the version of the ORCD

Returns:

asTable

public herschel.ia.dataset.TableDataset asTable()

getModes

public java.util.HashMap<java.lang.Long,java.lang.String> getModes(java.lang.String sequence)

Get the modes and times that a sequence will trigger

Parameters:

sequence -

Returns:

a Hashmap containing couples of long (number of seconds) and the mode name

getModesAsHistory

public java.util.HashMap<java.lang.Long,java.lang.String> getModesAsHistory(AbstractSequence sequence)

Get the times and the modes that a sequence will trigger. So if the sequence AAAA is defined in the MIB to make the spacecraft to go to mode A1 in 0 seconds and A2 in 30 seconds, it will add 0 to the execution time and 30 secs.

Parameters:

sequence -

Returns:

a Hashmap containing couples of long (with the long representation of the date when the mode transition will happen) and the mode name

getModesAsHistory

public java.util.HashMap<java.lang.Long,java.lang.String> getModesAsHistory(java.lang.String sequence,
                                                                   java.util.Date initialTime)

Get the times and the modes that a sequence will trigger. So if the sequence AAAA is defined in the MIB to make the spacecraft to go to mode A1 in 0 seconds and A2 in 30 seconds, it will add 0 to the initial time and 30 secs.

Parameters:

sequence -

initialTime -

Returns:

a Hashmap containing couples of long (with the long representation of the date when the mode transition will happen) and the mode name

getModesAsHistory

public java.util.HashMap<java.lang.Long,java.lang.String> getModesAsHistory(java.lang.String sequence,
                                                                   long initialTime)

Get the times and the modes that a sequence will trigger. So if the sequence AAAA is defined in the MIB to make the spacecraft to go to mode A1 in 0 seconds and A2 in 30 seconds, it will add 0 to the initial time and 30 secs.

Parameters:

sequence -

initialTime -

Returns:

a Hashmap containing couples of long (with the long representation of the date when the mode transition will happen) and the mode name

checkTransion

public boolean checkTransion(java.lang.String mode1,
                    java.lang.String mode2)

Check if transition from a mode to another is allowed in the ORCD

Parameters:

mode1 - current mode

mode2 - the mode to go to

Returns:

True if the transition is allowed or False otherwise

getPowerForMode

public float getPowerForMode(java.lang.String mode)

Get the power defined in the ORCD for a given mode

Parameters:

mode -

Returns:

The power defined in the ORCD for the given mode

getTotalPowerForModes

public float getTotalPowerForModes(java.lang.String[] modes)

Get the total power for a list of modes (just the sum of the power defined for each mode)

Parameters:

modes - Array of mode names

Returns:

the total power for all the modes given

writeToXmlFile

public void writeToXmlFile(java.lang.String file)

Write the ORCD representation to a XML file

Parameters:

file - full path of the target XML file

readORCDXmlfromJar

public static Orcd readORCDXmlfromJar()

Read the XML from a jar file in the class path. It will try to locate the file /mib/orcd.xml in the class path

Returns:

The ORCD

readORCDXmlfile

public static Orcd readORCDXmlfile(java.lang.String xmlFile)

Read the ORCD from a XML file

Parameters:

xmlFile - The xml file full path

Returns:

The ORCD

toXml

public java.lang.String toXml()

Get a XML representation of the ORCD

Returns: