org.lsst.ccs.subsystems.shutter

Class CCSConfigurationService

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystems.shutter.CCSConfigurationService

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable, ConfigurationService

public final class CCSConfigurationService
extends org.lsst.ccs.framework.ConfigurableComponent
implements ConfigurationService

Implements interface ConfigurationService using the CCS Configuration API. An instance of this will be created by the subsystem build script and named "configService". It draws its data from the components named "shutter", "minusx", "plusx" and "hall".

Author:

tether

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
CCSConfigurationService()

Method Summary

Modifier and Type	Method and Description
static BladeSetConfiguration	convertBladeSetConfiguration(Logger log, ShutterSide side, Map<String,String> raw) Performs checking and conversion for raw blade set configuration data.
static List<HallConfiguration>	convertHallConfigurations(Logger log, List<String> raw) Performs checking and conversion for raw Hall configuration data.
static ShutterConfiguration	convertShutterConfiguration(Logger log, Map<String,String> raw) Performs checking and conversion for raw shutter configuration data.
Map<ShutterSide,BladeSetConfiguration>	getBladeSetConfigurations(Logger log) {@inheritDoc
List<HallConfiguration>	getHallConfigurations(Logger log) {@inheritDoc
ShutterConfiguration	getShutterConfiguration(Logger log) {@inheritDoc

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.Configurable

change, dropSubmittedChanges, getCheckedValueFromConfiguration, getComponentByName, getName, getParent, getParentObject, getSubmittedChanges, getSubsystem, init, isParameterConfigurable, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, printConfigurableParameters, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

Constructor Detail

CCSConfigurationService

public CCSConfigurationService()

Method Detail

getHallConfigurations

public List<HallConfiguration> getHallConfigurations(Logger log)

{@inheritDoc

Specified by:

getHallConfigurations in interface ConfigurationService

Parameters:

log - Used to log errors.

Returns:

The list of Hall configurations, or null if any configuration was invalid.

getBladeSetConfigurations

public Map<ShutterSide,BladeSetConfiguration> getBladeSetConfigurations(Logger log)

{@inheritDoc

Specified by:

getBladeSetConfigurations in interface ConfigurationService

Parameters:

log - Used to log errors.

Returns:

A map from each side of the shutter to its blade set configuration, or null if either configuration was invalid.

getShutterConfiguration

public ShutterConfiguration getShutterConfiguration(Logger log)

{@inheritDoc

Specified by:

getShutterConfiguration in interface ConfigurationService

Parameters:

log - Used to log errors.

Returns:

The configuration object, or null if the configuration was invalid.

convertHallConfigurations

public static List<HallConfiguration> convertHallConfigurations(Logger log,
                                                                List<String> raw)

Performs checking and conversion for raw Hall configuration data. This is exposed so that one can use either what's provided by the CCS configuration API or use the result of running the input conversion engine on a properties file.

Parameters:

log - used for recording errors.

raw - the output of the conversion engine or the configuration API.

Returns:

either null if there were any errors, or the list of converted configuration items.

convertBladeSetConfiguration

public static BladeSetConfiguration convertBladeSetConfiguration(Logger log,
                                                                 ShutterSide side,
                                                                 Map<String,String> raw)

Performs checking and conversion for raw blade set configuration data. This is exposed so that one can use either what's provided by the CCS configuration API or use the result of running the input conversion engine on a properties file.

Parameters:

log - used for recording errors.

raw - the output of the conversion engine or the configuration API.

Returns:

either null if there were any errors, or converted configuration.

convertShutterConfiguration

public static ShutterConfiguration convertShutterConfiguration(Logger log,
                                                               Map<String,String> raw)

Performs checking and conversion for raw shutter configuration data. This is exposed so that one can use either what's provided by the CCS configuration API or use the result of running the input conversion engine on a properties file.

Parameters:

log - used for recording errors.

raw - the output of the conversion engine or the configuration API.

Returns:

either null if there were any errors, or converted configuration.