vega.uplink.commanding

Class Mib

java.lang.Object

CompositeDataset

vega.uplink.commanding.Mib

public class Mib
extends CompositeDataset

The MIB to be used. It only contains the tables from the MIB relevant for mission planning The tables read are SDF, CSP, CDF, CPC and CSS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkParameter(Parameter param) Check if the representation and radix of a parameter is the same as defined in the MIB
boolean	checkParameterSequence(java.lang.String sequence, java.lang.String parameter) Check if a particular sequence has a given parameter defined in the MIB or not
boolean	checkSequence(SequenceInterface seq)
boolean	checkSequence(java.lang.String sequence) Check if a sequence exist in the MIB
java.lang.String[]	getAllSequences() Return an array with all valid sequences names
Parameter	getDefaultParameter(java.lang.String parameterName) Get the default Parameter definition in the MIB for a parameter name
Parameter[]	getDefaultParameters(java.lang.String sequence) Get the defaulr parameters for a sequence name
static Mib	getMib() Get the MIB.
static Mib	getMibFromFiles() Read the MIB from files.
static Mib	getMibFromJar() Read the MIB from the jars in the class path.
java.lang.String	getParameterDescription(java.lang.String parameterName) Get the description of a parameter in the MIB
java.lang.String	getSequenceDescription(java.lang.String sequenceName) Get the description in the MIB of a given sequence
long	getTotalSequenceDuration(java.lang.String sequenceName) Get the total duration in seconds of a sequence as defined in the MIB

Methods inherited from class java.lang.Object

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

Method Detail

getMibFromFiles

public static Mib getMibFromFiles()
                           throws java.io.IOException

Read the MIB from files. The location will be read from the properties

Returns:

the MIB

Throws:

java.io.IOException - In the case the files are not found or are not readable

getMibFromJar

public static Mib getMibFromJar()
                         throws java.io.IOException

Read the MIB from the jars in the class path. The need to be in a directory called mib in the first level of the class path

Returns:

The MIB

Throws:

java.io.IOException - IN case that the directory mib is not found in the class path

checkSequence

public boolean checkSequence(java.lang.String sequence)

Check if a sequence exist in the MIB

Parameters:

sequence - The sequence name to be checked

Returns:

True if the sequence exist and false otherwise

getDefaultParameters

public Parameter[] getDefaultParameters(java.lang.String sequence)

Get the defaulr parameters for a sequence name

Parameters:

sequence - The sequence name

Returns:

Array with the default parameters defined in the mib for the given sequence

checkParameterSequence

public boolean checkParameterSequence(java.lang.String sequence,
                             java.lang.String parameter)

Check if a particular sequence has a given parameter defined in the MIB or not

Parameters:

sequence - Sequence name

parameter - Parameter name

Returns:

True if the parameter is defined in the MIB for the given sequence. False otherwise

checkParameter

public boolean checkParameter(Parameter param)

Check if the representation and radix of a parameter is the same as defined in the MIB

Parameters:

param - Parameter to be checked

Returns:

True if the parameter representation and radix are the same as defined in the MIB

Throws:

java.lang.IllegalArgumentException - If the representation or radix are different. The message in the exception will actually say what is the problem

checkSequence

public boolean checkSequence(SequenceInterface seq)

getDefaultParameter

public Parameter getDefaultParameter(java.lang.String parameterName)

Get the default Parameter definition in the MIB for a parameter name

Parameters:

parameterName - The parameter name

Returns:

The parameter as default definition in the MIB

getMib

public static Mib getMib()

Get the MIB. It will try first to read the MIB form files, from the location defined in the properties. Then it will try to read it form the jar files in the class path. If it fails as well, the it will crate an empty MIB.

Returns:

the MIB

getParameterDescription

public java.lang.String getParameterDescription(java.lang.String parameterName)

Get the description of a parameter in the MIB

Parameters:

parameterName -

Returns:

The description if the parameter

getAllSequences

public java.lang.String[] getAllSequences()

Return an array with all valid sequences names

Returns:

getSequenceDescription

public java.lang.String getSequenceDescription(java.lang.String sequenceName)

Get the description in the MIB of a given sequence

Parameters:

sequenceName - Sequence name

Returns:

The description of the sequence

getTotalSequenceDuration

public long getTotalSequenceDuration(java.lang.String sequenceName)

Get the total duration in seconds of a sequence as defined in the MIB

Parameters:

sequenceName - The sequence name

Returns:

Duration in seconds