org.lsst.ccs.subsystem.common

Class MonitorTaskControl

java.lang.Object

org.lsst.ccs.subsystem.common.MonitorTaskControl

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

public class MonitorTaskControl
extends Object
implements org.lsst.ccs.framework.HasLifecycle

Controls special monitoring tasks.

Author:

saxton

Constructor Summary

Constructors

Constructor and Description
MonitorTaskControl()

Method Summary

Modifier and Type	Method and Description
static MonitorTaskControl	createNode(org.lsst.ccs.Subsystem subsys, String name) Create a new object and add it to the tree.
Map<String,MonitorTask>	getMonitorTaskMap() Gets the map of monitoring task pairs.
int	getPublishPeriod() Gets the monitoring publishing period.
List<String>	getTaskNames() Command to get the list of known special monitor task pair names.
boolean	hasPeriodChanged() Gets whether update period has changed.
void	postInit() Post-init phase.
void	setPublishPeriod(int period) Command to set the monitor publishing period.
void	setTaskActive(String taskName, boolean active) Command to set the active state for a special monitor task pair.
void	setTaskPeriod(String taskName, int period) Command to set the period for a special monitor task pair.

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

build, init, postBuild, postShutdown, postStart, shutdown, start

Constructor Detail

MonitorTaskControl

public MonitorTaskControl()

Method Detail

createNode

public static MonitorTaskControl createNode(org.lsst.ccs.Subsystem subsys,
                                            String name)

Create a new object and add it to the tree.

Parameters:

subsys - The subsystem object

name - The name of this node

Returns:

The created object

postInit

public void postInit()

Post-init phase.

Specified by:

postInit in interface org.lsst.ccs.framework.HasLifecycle

setPublishPeriod

@Command(type=ACTION,
         description="Set the monitor publish period")
public void setPublishPeriod(@Argument(description="The publish period (ms)")
                                                                                                          int period)

Command to set the monitor publishing period.

Parameters:

period - The period (milliseconds) to set.

getTaskNames

@Command(type=QUERY,
         level=0,
         description="Get the special monitor task names")
public List<String> getTaskNames()

Command to get the list of known special monitor task pair names.

Returns:

The list of names

setTaskPeriod

@Command(type=ACTION,
         description="Set the period for a special monitor task")
public void setTaskPeriod(@Argument(description="The task name")
                                                                                                                  String taskName,
                                                                                                                  @Argument(description="The task period (ms)")
                                                                                                                  int period)

Command to set the period for a special monitor task pair.

Parameters:

taskName - The name of the task

period - The period (ms)

setTaskActive

@Command(type=ACTION,
         description="Set the active state for a special monitor task")
public void setTaskActive(@Argument(description="The task name")
                                                                                                                        String taskName,
                                                                                                                        @Argument(description="Whether to make active")
                                                                                                                        boolean active)

Command to set the active state for a special monitor task pair.

Parameters:

taskName - The name of the task

active - Whether to activate or not

hasPeriodChanged

public boolean hasPeriodChanged()

Gets whether update period has changed.

Returns:

Whether changed

getMonitorTaskMap

public Map<String,MonitorTask> getMonitorTaskMap()

Gets the map of monitoring task pairs.

Returns:

The map

getPublishPeriod

public int getPublishPeriod()

Gets the monitoring publishing period.

Returns:

The publishing period (ms)