org.lsst.ccs

Class PeriodicTaskComponent

java.lang.Object

org.lsst.ccs.PeriodicTaskComponent

All Implemented Interfaces:

HasLifecycle

public class PeriodicTaskComponent
extends Object
implements HasLifecycle

An Object containing a PeriodicTaks to be executed by the Subsystem. TO-DO : this should be made package protected when Module.setTickMillis is removed.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
long	getTaskPeriodMillis() Returns the task period in milliseconds.
void	setTaskPeriodMillis(long taskPeriodMillis) Changes the task period in milliseconds.
void	shutdownNow() Called from the enclosing Subsystem when Agent.shutdown() has been called.
void	start() Called from the enclosing Subsystem when Subsystem.start() has been called.

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.HasLifecycle

init, postInit, postStart

Method Detail

setTaskPeriodMillis

@ConfigurationParameterChanger(propertyName="taskPeriodMillis")
public void setTaskPeriodMillis(long taskPeriodMillis)

Changes the task period in milliseconds. TODO : make package protected when Module.setTickMillis is removed.

Parameters:

taskPeriodMillis -

getTaskPeriodMillis

public long getTaskPeriodMillis()

Returns the task period in milliseconds. TODO : remove when Module.getTickmillis is removed.

Returns:

the task period

shutdownNow

public void shutdownNow()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem when Agent.shutdown() has been called. At the time it is called :

• PhaseState is CLOSING.
• HardwareController.checkStopped() has been called

It should be overridden to free non hardware related resources.

If overridden from Module, a call to super.shutdownNow() is required.

Specified by:

shutdownNow in interface HasLifecycle

start

public void start()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem when Subsystem.start() has been called. At the time it is called :

• the PhaseState is INITIALIZING
• connection with the messaging layer is effective, the enclosing subsystem has started StatusHeartBeat publication
• the startup configuration has been loaded (if provided)

It is unnecessary to call super.start()

Specified by:

start in interface HasLifecycle