org.lsst.ccs

Interface UsesSubsystem

All Known Subinterfaces:

Configurable

All Known Implementing Classes:

Alarm, CalcDevice, Channel, ConfigurableComponent, Control, Device, Line, Module, MonMain, Page

public interface UsesSubsystem

Utility interface that provides to the implementing component access to various external information, such as the enclosing the subsystem, its component lookup, the component name or the component configuration environment.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
default ComponentConfigurationEnvironment	getComponentConfigurationEnvironment() Gets the ComponentConfigurationEnvironment for this object.
default ComponentLookup	getComponentLookup() Returns the component lookup of the subsystem this component belongs to.
default String	getName() Return the name for this object.
default Subsystem	getSubsystem() Get the Subsystem for the object implementing this interface.

Method Detail

getSubsystem

default Subsystem getSubsystem()

Get the Subsystem for the object implementing this interface. This object must belong to the Subsystem's ComponentLookupService. The Subsystem is generally unavailable when the Component is created. It is available only after the Subsystem has been built from the ComponentLookupService. This method will throw a RuntimeException if the Subsystem is not available.

Returns:

The Subsystem to which this object belongs to. If no subsystem is available for this object, a RuntimeException is thrown, which indicates the method has been invoked too early.

getName

default String getName()

Return the name for this object. This name will not be null only if this object is a node in a tree built from a groovy description file. TO-DO: Have to review this. We could also allow trees to be built from java.

Returns:

The Object Name.

getComponentLookup

default ComponentLookup getComponentLookup()

Returns the component lookup of the subsystem this component belongs to.

Returns:

The component

getComponentConfigurationEnvironment

default ComponentConfigurationEnvironment getComponentConfigurationEnvironment()

Gets the ComponentConfigurationEnvironment for this object. The object must be part of a Subsystem's ComponentLookupService. ComponentConfigurationEnvironment objects can be fetched, either by name or by Object, using the following static methods on the Subsystem class:

• Subsystem.getSubsystemForObject(this).getConfigurationEnvironmentForComponent(Object obj)
• Subsystem.getSubsystemForObject(this).getConfigurationEnvironmentByName(String name)

This method provides a utility method to wrap the above ones and expose the ComponentConfigurationEnvironment for the class implementing this interface.

Returns:

The ComponentConfigurationEnvironment for this object or null if it cannot be found.