org.mbs.services.cup.data

Class ControlUnitInfo

java.lang.Object

org.mbs.services.cup.data.ControlUnitInfo

public class ControlUnitInfo
extends java.lang.Object

This class represents a structure holding control unit information. The ControlUnitInfo could be in one of the three modes: ID, CHECKSUM or STATE. Optionally it may bear info about its parent control units.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	checksum Checksum for this control unit's state.
static int	CHECKSUM When ControlUnitInfo is in SCHECKSUM, it bears a checksum value for the control unit's state.
protected boolean	hasParentsInfo Flag indicating whether this object bears parent info.
protected java.lang.String	id Id of this control unit.
static int	ID When ControlUnitInfo is in ID mode, it bears only the cu identifications - the cu type and cu id.
protected int	mode Mode of this ControlUnitInfo.
static java.lang.String	NULL_VALUE
protected ControlUnitInfo[]	parents List of control units.
protected java.util.Dictionary	state The control unit's state.
static int	STATE When ControlUnitInfo is in STATE, it bears the control unit's state.
protected java.lang.String	type Type of this control unit.

Constructor Summary

Constructors

Constructor and Description
ControlUnitInfo()

Method Summary

Modifier and Type	Method and Description
static int	calcCheckSum(ControlUnitInfo cuInfo) Calculates the checksum of given ControlUnitInfo object in STATE mode.
static int	calcCheckSum(java.lang.String[] stateInterface, java.lang.Object[] values) Calculates the checksum of control unit state.
int	getCheckSum() Returns the checksum for this control unit's state.
java.lang.String	getId() Returns the id of this control unit.
int	getMode() Returns the mode of this ControlUnitInfo.
ControlUnitInfo[]	getParentsInfo() Returns parent info - list of control units that are parents of this control unit.
java.lang.String[]	getStateInterface() Returns the list of ids of state variables held in this ControlunitInfo object.
java.util.Dictionary	getStateVaraibles() Deprecated. the prefered way is to use the pair of methods getStateInterface() and getValue(String)
java.lang.String	getType() Returns the type of this control unit.
java.lang.Object	getValue(java.lang.String stateVariableId) Returns the value of given state variable.
boolean	hasParentsInfo() Tells whether this object bears parent info.
boolean	read(java.io.DataInputStream in) Method used for serialization.
java.lang.String	toString()
void	write(java.io.DataOutputStream out) Method used for serialization.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_VALUE

public static final java.lang.String NULL_VALUE

See Also:

Constant Field Values

mode

protected int mode

Mode of this ControlUnitInfo. It could be one of the integer constants.

type

protected java.lang.String type

Type of this control unit.

id

protected java.lang.String id

Id of this control unit.

parents

protected ControlUnitInfo[] parents

List of control units.

hasParentsInfo

protected boolean hasParentsInfo

Flag indicating whether this object bears parent info.

checksum

protected int checksum

Checksum for this control unit's state. Available when object is in SCHECKSUM.

state

protected java.util.Dictionary state

The control unit's state. Available when object is in STATE.

ID

public static final int ID

When ControlUnitInfo is in ID mode, it bears only the cu identifications - the cu type and cu id.

See Also:

Constant Field Values

CHECKSUM

public static final int CHECKSUM

When ControlUnitInfo is in SCHECKSUM, it bears a checksum value for the control unit's state.

See Also:

Constant Field Values

STATE

public static final int STATE

When ControlUnitInfo is in STATE, it bears the control unit's state.

See Also:

Constant Field Values

Constructor Detail

ControlUnitInfo

public ControlUnitInfo()

Method Detail

getMode

public int getMode()

Returns the mode of this ControlUnitInfo. It could be one of the integer constants.

Returns:

the control unit mode.

getType

public java.lang.String getType()

Returns the type of this control unit.

Returns:

the control unit type.

getId

public java.lang.String getId()

Returns the id of this control unit.

Returns:

the control unit type.

getStateVaraibles

public java.util.Dictionary getStateVaraibles()

Deprecated. the prefered way is to use the pair of methods getStateInterface() and getValue(String)

Returns the control unit's state. Available when object is in STATE.

Returns:

Dictionary with key-value pairs (stateVarId->value). State variables with null values are also present in this Dictionary. Their key-value pair is (stateVarId->NULL_VALUE).

getStateInterface

public java.lang.String[] getStateInterface()

Returns the list of ids of state variables held in this ControlunitInfo object.

Returns:

list of state variable ids

getValue

public java.lang.Object getValue(java.lang.String stateVariableId)

Returns the value of given state variable.

Parameters:

stateVariableId - id of state variable.

Returns:

state variable value.

Throws:

IllegalArumentException - if the given state variable does not exist in this info object. Variable ids that exist in this info object could be obtained through getStateInterface() method.

getCheckSum

public int getCheckSum()

Returns the checksum for this control unit's state. Available when object is in SCHECKSUM.

Returns:

checksum of the control unit's state.

hasParentsInfo

public boolean hasParentsInfo()

Tells whether this object bears parent info. Parents info is available through the getParentsInfo method.

Returns:

true of this object bears parent info, false otherwise.

getParentsInfo

public ControlUnitInfo[] getParentsInfo()

Returns parent info - list of control units that are parents of this control unit. Control units returned by this method are always in ID mode.

Returns:

a list of the control unit's parents.

calcCheckSum

public static final int calcCheckSum(ControlUnitInfo cuInfo)

Calculates the checksum of given ControlUnitInfo object in STATE mode.

Parameters:

cuInfo - ControlUnitInfo object which checksum should be calculated.

Returns:

checksum value

Throws:

java.lang.IllegalArgumentException - if given ControlUnitInfo object is not in STATE mode.

calcCheckSum

public static final int calcCheckSum(java.lang.String[] stateInterface,
                                     java.lang.Object[] values)

Calculates the checksum of control unit state. The control unit state is given as two arrays holding the list of state variable names (stateInterface) and their respective values (values). The element at position [i] in the values array must host the value of the state variable in position [i] of the stateInterface array.

Parameters:

stateInterface - list of state variable names.

values - list of state variable values.

Returns:

checksum of the control unit state.

Throws:

java.lang.IllegalArgumentException - if the arrays passed are not of the same length.

read

public boolean read(java.io.DataInputStream in)
             throws java.io.IOException

Method used for serialization.

Parameters:

in - input stream.

Throws:

java.io.IOException - if error while reading data occurs.

write

public void write(java.io.DataOutputStream out)
           throws java.io.IOException

Method used for serialization.

Parameters:

out - output stream.

Throws:

java.io.IOException - error while writing data occurs.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object