net.happybrackets.core.control

Class TriggerControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.TriggerControl

Direct Known Subclasses:

TriggerControlSender

public class TriggerControl
extends DynamicControlParent

This class encapsulates the functionality of DynamicControl classes of type ControlType.TRIGGER in a simple API. Trigger controls do not have an internal value.

All TriggerControl controls with the same name and ControlScope will respond to a message send(). For example, consider two TriggerControl objects with the same ControlScope and name.

    TriggerControl control1 = new TriggerControl(this, "Send");

    TriggerControl control2 = new TriggerControl(this, "Send") {
         @Override
        public void triggerEvent() {
            System.out.println("Received Trigger");
        }
    };

    control1.send();
 

This will cause the triggerEvent() function to be called, causing Received Trigger to be printed to standard output

The control can also schedule trigger messages to be sent at a time in the future by adding the scheduled time to the message send(double) function. Eg

control1.send (HB.getSchedulerTime() + 1000); // this will trigger control1 value, as well as all other TriggerControls with same ControlScope and name, 1 second in the future.

Triggering an event within the HappyBrackets control display is effected by clicking the button associated with the control If you require a handler on the class, override the triggerEvent() function

Constructor Summary

Constructors

Constructor and Description
TriggerControl(java.lang.Object parent_sketch, java.lang.String name) Create a Trigger Dynamic Control

Method Summary

Modifier and Type	Method and Description
void	send() Send a trigger event.
void	send(double scheduler_time) Send a trigger event at a specific time.
TriggerControl	setControlScope(ControlScope new_scope) Changed the scope that the control has.
TriggerControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object as DynamicControl.DISPLAY_TYPE We must do this in subclass
void	triggerEvent() Triggered events are received through this function after calling send() on the object.

Methods inherited from class net.happybrackets.core.control.DynamicControlParent

addControlListener, addControlScopeListener, addControlTarget, addControlTarget, clearControlTargets, getDynamicControl, getSendingDevice, removeControlListener, removeControlScopeChangedListener, removeControlTarget, removeControlTarget, removeListeners, setControlTarget, setControlTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerControl

public TriggerControl(java.lang.Object parent_sketch,
                      java.lang.String name)

Create a Trigger Dynamic Control

Parameters:

parent_sketch - The parent object for control

name - the name to display

Method Detail

send

public void send()

Send a trigger event. This will pass the message on to all other DynamicControl with matching name, type and ControlScope and call triggerEvent().

     TriggerControl control1 = new TriggerControl(this, "Send");

     TriggerControl control2 = new TriggerControl(this, "Send") {
         @Override
        public void triggerEvent() {
            System.out.println("Received Trigger");
        }
     };

     control1.send();
     

This will cause the triggerEvent() function to be called, causing Received Trigger to be printed to standard output

send

public void send(double scheduler_time)

Send a trigger event at a specific time. Identical to the send() with the exception that the triggerEvent() event will be caused at the HBScheduler scheduled time passed in. For example:

     TriggerControl control1 = new TriggerControl(this, "Send");

     TriggerControl control2 = new TriggerControl(this, "Send") {
         @Override
        public void triggerEvent() {
            System.out.println("Received Trigger");
        }
     };
     control1.send (HB.getSchedulerTime() + 1000); // this will trigger control1 value, as well as all other TriggerControls with same ControlScope and name, 1 second in the future.
     

Parameters:

scheduler_time - the scheduler time this is supposed to occur at

triggerEvent

public void triggerEvent()

Triggered events are received through this function after calling send() on the object. For example:

    TriggerControl control1 = new TriggerControl(this, "Send");

    TriggerControl control2 = new TriggerControl(this, "Send") {
         @Override
            public void triggerEvent() {
            System.out.println("Received Trigger");
        }
    };
     control1.send();
     

setControlScope

public TriggerControl setControlScope(ControlScope new_scope)

Changed the scope that the control has. It will update control map so the correct events will be generated based on its scope We must do this in subclass

Overrides:

setControlScope in class DynamicControlParent

Parameters:

new_scope - The new Control Scope

Returns:

this object

setDisplayType

public TriggerControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Change how to display object as DynamicControl.DISPLAY_TYPE We must do this in subclass

Parameters:

display_type - The new display type

Returns:

this object