PamController
Class PamSettingsGroup

java.lang.Object
  PamController.PamSettingsGroup

All Implemented Interfaces:

java.lang.Comparable<PamSettingsGroup>

public class PamSettingsGroup
extends java.lang.Object
implements java.lang.Comparable<PamSettingsGroup>

Stores a group of PAMGUARD settings read back from the database or some other store (e.g. binary storage).

The group of settings contains three things: 1) A time 2) A list of installed units 3) A list of settings (this is included as part of one of the unitSettings from Pam Controller)

Author:

Doug Gillespie

See Also:

DBControlUnit, BinaryStore

Field Summary

private long	settingsTime
private java.util.ArrayList<PamControlledUnitSettings>	unitSettings

Constructor Summary

PamSettingsGroup(long settingsTime)
Create a new settings unit, which will contain all the settings of a configuration at a particular time

Method Summary

void	addSettings(PamControlledUnitSettings pamControlledUnitSettings) Add settings to the list of different unit settings
int	compareTo(PamSettingsGroup o)
PamControlledUnitSettings	findUnitSettings(java.lang.String unitType, java.lang.String unitName) find the unit settings for a module of a given name and type.
(package private) int	getNumSettings()
long	getSettingsTime()
java.util.ArrayList<PamControlledUnitSettings>	getUnitSettings()
PamControlledUnitSettings	getUnitSettings(int settingsNo) Get a particular set of settings.
java.util.ArrayList<UsedModuleInfo>	getUsedModuleInfo() Return the list of used modules.
void	setSettingsTime(long settingsTime)

Methods inherited from class java.lang.Object

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

Field Detail

settingsTime

private long settingsTime

unitSettings

private java.util.ArrayList<PamControlledUnitSettings> unitSettings

Constructor Detail

PamSettingsGroup

public PamSettingsGroup(long settingsTime)

Create a new settings unit, which will contain all the settings of a configuration at a particular time

Parameters:

settingsTime - settings time in milliseconds.

Method Detail

compareTo

public int compareTo(PamSettingsGroup o)

Specified by:

compareTo in interface java.lang.Comparable<PamSettingsGroup>

getSettingsTime

public long getSettingsTime()

Returns:

the millisecond timestamp of the unit settings

setSettingsTime

public void setSettingsTime(long settingsTime)

Parameters:

settingsTime - the settingsTime to set

addSettings

public void addSettings(PamControlledUnitSettings pamControlledUnitSettings)

Add settings to the list of different unit settings

Parameters:

pamControlledUnitSettings - new settings

getUnitSettings

public java.util.ArrayList<PamControlledUnitSettings> getUnitSettings()

Returns:

the complete array list of different unit settings

getUnitSettings

public PamControlledUnitSettings getUnitSettings(int settingsNo)

Get a particular set of settings.

Parameters:

settingsNo - Settings number

Returns:

unit settings

getNumSettings

int getNumSettings()

Returns:

the number of different unit settings

findUnitSettings

public PamControlledUnitSettings findUnitSettings(java.lang.String unitType,
                                                  java.lang.String unitName)

find the unit settings for a module of a given name and type.

Parameters:

unitType - unit type

unitName - unit name

Returns:

unit settings, or null if none found

getUsedModuleInfo

public java.util.ArrayList<UsedModuleInfo> getUsedModuleInfo()

Return the list of used modules. These were / are settings returned by the PamController.

Returns:

list of used modules.