vega.uplink.commanding

Class ModelState

java.lang.Object

CompositeDataset

vega.uplink.commanding.ModelState

public class ModelState
extends CompositeDataset

Class to store the status of the spacecraft (states of the instruments and power consumed) at any given time. Within this class the definition of the following items may be confusing: Subsystem: a spacecraft subsystem. It is is not an instrument, as instruments may have different subsystems State: state of an subinstrument Mode: it is composed of the subinstrument and the state. It is build as subinstrument_state example: Mode or state : AL_HV_Off SubSystem: AL_HV_ Instrument: AL (Alice)

Constructor Summary

Constructors

Constructor and Description
ModelState() Creates an empty status

Method Summary

Methods

Modifier and Type	Method and Description
ModelState	clone()
java.lang.String[]	getAllStates() Get all states or modes
float	getInstrumentPower(java.lang.String instrument) Get the power consumption of an instrument
static ModelState	getModelState()
java.lang.String	getState(java.lang.String subSystem) Get the state of an subsystem
java.lang.String	getStateForMode(java.lang.String mode) For a give mode (subsystem_state) get the current state
java.lang.String[]	getSubsystemNames() Get all subsystem names
float	getTotalPower() Get the total power consumption from all the instrument
void	initFromFile(java.lang.String file) Init the states from a file
void	reset() Reset this model state
void	saveStateAsInitScript(java.lang.String file) Save the status as a init file in jython
void	saveStatus(java.lang.String file) Save the current status to a file
void	setInstrument(java.lang.String instrument, float newPower) Set the power consumption of an instrument in this status
void	setState(java.lang.String mode) Set the state.
void	setState(java.lang.String subSystem, java.lang.String state) Set the state for a subsystem
java.lang.String	toString()
String1d	toString1d()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelState

public ModelState()

Creates an empty status

Method Detail

setInstrument

public void setInstrument(java.lang.String instrument,
                 float newPower)

Set the power consumption of an instrument in this status

Parameters:

instrument -

newPower -

getInstrumentPower

public float getInstrumentPower(java.lang.String instrument)

Get the power consumption of an instrument

Parameters:

instrument -

Returns:

getTotalPower

public float getTotalPower()

Get the total power consumption from all the instrument

Returns:

getState

public java.lang.String getState(java.lang.String subSystem)

Get the state of an subsystem

Parameters:

subSystem -

Returns:

setState

public void setState(java.lang.String subSystem,
            java.lang.String state)

Set the state for a subsystem

Parameters:

subSystem -

state -

setState

public void setState(java.lang.String mode)

Set the state. The mode is build as subsystem_state

Parameters:

mode -

getStateForMode

public java.lang.String getStateForMode(java.lang.String mode)

For a give mode (subsystem_state) get the current state

Parameters:

mode -

Returns:

getModelState

public static ModelState getModelState()

reset

public void reset()

Reset this model state

getSubsystemNames

public java.lang.String[] getSubsystemNames()

Get all subsystem names

Returns:

getAllStates

public java.lang.String[] getAllStates()

Get all states or modes

Returns:

toString

public java.lang.String toString()

toString1d

public String1d toString1d()

saveStatus

public void saveStatus(java.lang.String file)

Save the current status to a file

Parameters:

file -

saveStateAsInitScript

public void saveStateAsInitScript(java.lang.String file)

Save the status as a init file in jython

Parameters:

file -

initFromFile

public void initFromFile(java.lang.String file)

Init the states from a file

Parameters:

file -

clone

public ModelState clone()