HBScheduler (HappyBrackets API)

java.lang.Object
- net.happybrackets.core.scheduling.HBScheduler

```
public class HBScheduler
extends java.lang.Object
```
Stores events with the time they need to be executed and executes them when they are due. These include Clock, Delay and DynamicControl
The global getGlobalScheduler() is the scheduler most scheduled events are triggered to. Moving the getGlobalScheduler() forward or backwards in time will cause the objects to have their events moved accordingly.
It is possible to run multiple HBScheduler if you want to synchronise to more than one epoch.
The time is stored in milliseconds a a Double, with the zero REFERENCE_TIME being 1 Dec 2018 on the System Clock.
The Scheduler can be synchronised to the System Clock through the function synchroniseClocks(). The offset between the scheduler and the System Clock can be obtained through getClockSkew() The scheduler can, however, be set to any time independent of the System Clock through calls to setScheduleTime(double) or adjustScheduleTime(double, long). The current scheduler time can be obtained through getSchedulerTime()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HBScheduler.MESSAGE_PARAMS

Nested Classes
Modifier and Type	Class and Description
`static class`	`HBScheduler.MESSAGE_PARAMS`

Field Summary

Fields
Modifier and Type Field and Description

static java.time.LocalDateTime REFERENCE_TIME
1 Dec 2018 is the global reference start clock.

Fields
Modifier and Type	Field and Description
`static java.time.LocalDateTime`	`REFERENCE_TIME` 1 Dec 2018 is the global reference start clock.

Constructor Summary

Constructors
Constructor and Description

HBScheduler(int priority)
Create a scheduler object

Constructors
Constructor and Description
`HBScheduler(int priority)` Create a scheduler object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScheduleChangeListener(ScheduleAdjustmentListener listener)` Add listener to be notified when our schedule change has completed
`ScheduledObject`	`addScheduledObject(double scheduled_time, java.lang.Object param, ScheduledEventListener listener)` Add an object that needs to be notified when its scheduled time has occurred If the scheduled time on this item is less than the current next scheduled item We will notify the scheduleObject so it waits the appropriate time
`void`	`adjustScheduleTime(double amount, long duration)` Adjust the scheduler time.
`static de.sciss.net.OSCMessage`	`buildNetworkSendMessage(java.lang.String OSC_MessageName, CustomGlobalEncoder adjustment)` Build OSC Message that specifies a Network update
`void`	`displayNotifyMessage()` Set flag to display notify messages to stdout for debugging and testing
`static boolean`	`enableProcessControlMessage(java.lang.String device_name, int message_id)` See if we will process a control message based on device name and message_id If the message_id is mapped against the device_name, ignore message, otherwise store mapping and return true;
`void`	`endScheduler()` End our scheduler.
`static double`	`getCalcTime()` Get the calculated time in ms from 1 Dec 2018 from System Clock
`double`	`getClockSkew()` Get the amount of time difference between system clock and our scheduler
`static HBScheduler`	`getGlobalScheduler()` Get singleton instance of HBScheduler
`double`	`getSchedulerTime()` Get the Scheduler time in milliseconds.
`static double`	`getUptime()` Get the time JVM has been running
`static boolean`	`ProcessSchedulerMessage(de.sciss.net.OSCMessage msg)` Process our Scheduler messages
`void`	`reset()` Erase all Scheduled objects from clock
`static void`	`setDeviceController()` Use a flag to set this as Controller so we can send messages from simulator as well as controller
`void`	`setScheduleTime(double new_time)` Set the scheduler time to this time
`double`	`synchroniseClocks()` Synchronise our timer with the system time on next tick
`double`	`synchroniseClocks(long slew_time)` Synchronise our timer with the system time

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REFERENCE_TIME
```
public static final java.time.LocalDateTime REFERENCE_TIME
```
    1 Dec 2018 is the global reference start clock.
- Constructor Detail
  - HBScheduler
```
public HBScheduler(int priority)
```
    Create a scheduler object
    
    Parameters:
    
    priority - the priority we want it to run. Thread.MAX_PRIORITY is highest
- Method Detail
  - setDeviceController
```
public static void setDeviceController()
```
    Use a flag to set this as Controller so we can send messages from simulator as well as controller
  - addScheduleChangeListener
```
public void addScheduleChangeListener(ScheduleAdjustmentListener listener)
```
    Add listener to be notified when our schedule change has completed
    
    Parameters:
    
    listener - listener
  - enableProcessControlMessage
```
public static boolean enableProcessControlMessage(java.lang.String device_name,
                                                  int message_id)
```
    See if we will process a control message based on device name and message_id If the message_id is mapped against the device_name, ignore message, otherwise store mapping and return true;
    
    Parameters:
    
    device_name - the device name
    
    message_id - the message_id
    
    Returns:
    
    true if we are going to process this message
  - getGlobalScheduler
```
public static HBScheduler getGlobalScheduler()
```
    Get singleton instance of HBScheduler
    
    Returns:
    
    the single static instance with maximum priority
  - displayNotifyMessage
```
public void displayNotifyMessage()
```
    Set flag to display notify messages to stdout for debugging and testing
  - getClockSkew
```
public double getClockSkew()
```
    Get the amount of time difference between system clock and our scheduler
    
    Returns:
    
    the amount of time difference between two clocks
  - synchroniseClocks
```
public double synchroniseClocks()
```
    Synchronise our timer with the system time on next tick
    
    Returns:
    
    the number of milliseconds we will be moving scheduler
  - synchroniseClocks
```
public double synchroniseClocks(long slew_time)
```
    Synchronise our timer with the system time
    
    Parameters:
    
    slew_time - the amount of milliseconds that we want to take to complete it
    
    Returns:
    
    the number of milliseconds we will be moving scheduler
  - getCalcTime
```
public static double getCalcTime()
```
    Get the calculated time in ms from 1 Dec 2018 from System Clock
    
    Returns:
    
    number of milliseconds since 1 Dec 2018 GMT
  - endScheduler
```
public void endScheduler()
```
    End our scheduler. Any items scheduled will be deleted
  - reset
```
public void reset()
```
    Erase all Scheduled objects from clock
  - addScheduledObject
```
public ScheduledObject addScheduledObject(double scheduled_time,
                                          java.lang.Object param,
                                          ScheduledEventListener listener)
```
    Add an object that needs to be notified when its scheduled time has occurred If the scheduled time on this item is less than the current next scheduled item We will notify the scheduleObject so it waits the appropriate time
    
    Parameters:
    
    scheduled_time - the time the item needs to be scheduled for
    
    param - the parameter to be passed back to the listener
    
    listener - the listener to be called when the scheduled event is supposed to occur
    
    Returns:
    
    the scheduled object that has been added
  - getUptime
```
public static double getUptime()
```
    Get the time JVM has been running
    
    Returns:
    
    the time JVM has been running
  - getSchedulerTime
```
public double getSchedulerTime()
```
    Get the Scheduler time in milliseconds. This function is particularly useful for scheduling event to occur in the future by adding the number of milliseconds in the future. An example of its usage is in FloatControl.setValue(double, double)
    
    Returns:
    
    the elapsed time in milliseconds
  - setScheduleTime
```
public void setScheduleTime(double new_time)
```
    Set the scheduler time to this time
    
    Parameters:
    
    new_time - the new time
  - adjustScheduleTime
```
public void adjustScheduleTime(double amount,
                               long duration)
```
    Adjust the scheduler time. For example, to advance the scheduler 200 ms over a five second period, we would use the following code
```
     HBScheduler scheduler = HBScheduler.getGlobalScheduler();
     scheduler.adjustScheduleTime(200, 5000);
 
```
    Likewise, a negative value will retard the scheduler time
    Parameters:
    
    amount - the amount of milliseconds we need to adjust our time by. A positive amount will advance the scheduler
    
    duration - the number of milliseconds over which we want this change to occur so we don't just get a jump
  - buildNetworkSendMessage
```
public static de.sciss.net.OSCMessage buildNetworkSendMessage(java.lang.String OSC_MessageName,
                                                              CustomGlobalEncoder adjustment)
```
    Build OSC Message that specifies a Network update
    
    Parameters:
    
    OSC_MessageName - The OSC Message
    
    adjustment - the CustomGlobalEncoder adjustment or message we are making
    
    Returns:
    
    OSC Message directed to controls with same name, scope, but on different devices
  - ProcessSchedulerMessage
```
public static boolean ProcessSchedulerMessage(de.sciss.net.OSCMessage msg)
```
    Process our Scheduler messages
    
    Parameters:
    
    msg - the OSC message we are processing
    
    Returns:
    
    true if we process this message

Class HBScheduler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REFERENCE_TIME

Constructor Detail

HBScheduler

Method Detail

setDeviceController

addScheduleChangeListener

enableProcessControlMessage

getGlobalScheduler

displayNotifyMessage

getClockSkew

synchroniseClocks

synchroniseClocks

getCalcTime

endScheduler

reset

addScheduledObject

getUptime

getSchedulerTime

setScheduleTime

adjustScheduleTime

buildNetworkSendMessage

ProcessSchedulerMessage