PamController
Class PamControlledUnitSettings

java.lang.Object
  PamController.PamControlledUnitSettings

All Implemented Interfaces:

java.io.Serializable

public class PamControlledUnitSettings
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

private static long	serialVersionUID
private java.lang.Object	settings
private java.lang.String	unitName
private java.lang.String	unitType
(package private) long	versionNo

Constructor Summary

PamControlledUnitSettings(byte[] data)

PamControlledUnitSettings(java.lang.String unitType, java.lang.String unitName, long versionNo, java.lang.Object settings)

Method Summary

static PamControlledUnitSettings	createFromByteArray(byte[] byteArray) Create an object from a serialised byte array
static PamControlledUnitSettings	createFromNamedByteArray(byte[] byteArray)
byte[]	getNamedSerialisedByteArray() Get a byte array of the serialised data but with a small header giving the unitType, unitName, versionNO and the size of the serialised data object
byte[]	getSerialisedByteArray() Get a byte array of the serialised data in this object.
java.lang.Object	getSettings()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
long	getVersionNo()
boolean	isSame(PamControlledUnitSettings p) Find out if a set of settings are compatible with another set.
boolean	isSettingsOf(java.lang.String unitType, java.lang.String unitName) Find out if this settings unit is that for the given type and name
void	setSettings(java.lang.Object settings)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

versionNo

long versionNo

unitType

private java.lang.String unitType

unitName

private java.lang.String unitName

settings

private java.lang.Object settings

Constructor Detail

PamControlledUnitSettings

public PamControlledUnitSettings(java.lang.String unitType,
                                 java.lang.String unitName,
                                 long versionNo,
                                 java.lang.Object settings)

PamControlledUnitSettings

public PamControlledUnitSettings(byte[] data)

Method Detail

getSettings

public java.lang.Object getSettings()

Returns:

The unit settings.

setSettings

public void setSettings(java.lang.Object settings)

Parameters:

settings - the settings to set

getUnitName

public java.lang.String getUnitName()

Returns:

The unit name

getUnitType

public java.lang.String getUnitType()

Returns:

The unit type

getVersionNo

public long getVersionNo()

Returns:

the version number for these unit settings.

isSettingsOf

public boolean isSettingsOf(java.lang.String unitType,
                            java.lang.String unitName)

Find out if this settings unit is that for the given type and name

Parameters:

unitType - Unit Type

unitName - Unit Name

Returns:

true if these settings correspond to that unit.

isSame

public boolean isSame(PamControlledUnitSettings p)

Find out if a set of settings are compatible with another set.

Parameters:

p - another set of PamControlledUnitSettings.

Returns:

true if they have the same name type and version number

getSerialisedByteArray

public byte[] getSerialisedByteArray()

Get a byte array of the serialised data in this object.

Returns:

a byte array of the serialised data in this object

getNamedSerialisedByteArray

public byte[] getNamedSerialisedByteArray()

Get a byte array of the serialised data but with a small header giving the unitType, unitName, versionNO and the size of the serialised data object

Returns:

byte array.

createFromNamedByteArray

public static PamControlledUnitSettings createFromNamedByteArray(byte[] byteArray)

createFromByteArray

public static PamControlledUnitSettings createFromByteArray(byte[] byteArray)

Create an object from a serialised byte array

Parameters:

byteArray - byte array

Returns:

new object (or null if invalid byte array)