Package heronarts.lx.parameter

Class TimeParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.AggregateParameter

heronarts.lx.parameter.TimeParameter

All Implemented Interfaces:

LXPath, LXParameter

public class TimeParameter
extends AggregateParameter

A time parameter is a utility for specifying a time of day in discrete hours, minutes, and seconds components.

Nested Class Summary

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields

Modifier and Type	Field	Description
final DiscreteParameter	hours
static final int	HOURS_PER_DAY
final DiscreteParameter	minutes
static final int	MINUTES_PER_HOUR
final DiscreteParameter	seconds
static final int	SECONDS_PER_DAY
static final int	SECONDS_PER_HOUR
static final int	SECONDS_PER_MINUTE

Fields inherited from class heronarts.lx.parameter.AggregateParameter

subparameters

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
TimeParameter(String label)

Method Summary

Modifier and Type	Method	Description
int	getSecondsOfDay()	Returns the stored time value as a number of seconds elapsed in the day
static int	getSecondsOfDay(int hours, int minutes, int seconds)
static int	getSecondsOfDay(Calendar calendar)
protected void	onSubparameterUpdate(LXParameter p)	Subclasses should update the main parameter value when a sub-parameter has changed
TimeParameter	setDescription(String description)
TimeParameter	setTime(int secondsOfDay)	Sets the time parameter to the given number of seconds in the day
TimeParameter	setTime(int hours, int minutes, int seconds)	Sets the value of the time parameter
protected void	updateSubparameters(double value)	Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Methods inherited from class heronarts.lx.parameter.AggregateParameter

addSubparameter, dispose, getRemoteControl, onUpdateValue, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, setFormatter, setMappable, setPolarity, setUnits, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.parameter.LXParameter

getBaseValue, getBaseValuef, getValuef

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

HOURS_PER_DAY

public static final int HOURS_PER_DAY

See Also:

• Constant Field Values

MINUTES_PER_HOUR

public static final int MINUTES_PER_HOUR

See Also:

• Constant Field Values

SECONDS_PER_MINUTE

public static final int SECONDS_PER_MINUTE

See Also:

• Constant Field Values

SECONDS_PER_HOUR

public static final int SECONDS_PER_HOUR

See Also:

• Constant Field Values

SECONDS_PER_DAY

public static final int SECONDS_PER_DAY

See Also:

• Constant Field Values

hours

public final DiscreteParameter hours

minutes

public final DiscreteParameter minutes

seconds

public final DiscreteParameter seconds

Constructor Details

TimeParameter

public TimeParameter(String label)

Method Details

setDescription

public TimeParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

setTime

public TimeParameter setTime(int hours,
 int minutes,
 int seconds)

Sets the value of the time parameter

Parameters:

hours - Hours of day (0-23)

minutes - Minutes of the hour (0-59)

seconds - Seconds of the hour (0-59)

Returns:

this

setTime

public TimeParameter setTime(int secondsOfDay)

Sets the time parameter to the given number of seconds in the day

Parameters:

secondsOfDay - Seconds in the day (0 - TimeParameter.SECONDS_PER_DAY - 1)

Returns:

this

getSecondsOfDay

public int getSecondsOfDay()

Returns the stored time value as a number of seconds elapsed in the day

Returns:

Number of seconds in the day this time represents

getSecondsOfDay

public static int getSecondsOfDay(int hours,
 int minutes,
 int seconds)

getSecondsOfDay

public static int getSecondsOfDay(Calendar calendar)

updateSubparameters

protected void updateSubparameters(double value)

Description copied from class: AggregateParameter

Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Specified by:

updateSubparameters in class AggregateParameter

onSubparameterUpdate

protected void onSubparameterUpdate(LXParameter p)

Description copied from class: AggregateParameter

Subclasses should update the main parameter value when a sub-parameter has changed

Specified by:

onSubparameterUpdate in class AggregateParameter

Parameters:

p - Subparameter that has changed