net.happybrackets.core.control

Class ClassObjectControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.ClassObjectControl

Direct Known Subclasses:

ClassObjectControlSender

public class ClassObjectControl
extends DynamicControlParent

This class encapsulates the functionality of DynamicControl classes of type ControlType.OBJECT in a simple API. This enables sending of entire classes as a single message.
For example, you can send x, y and z values a TripleAxisMessage using the setValue(Object)

All ClassObjectControl objects with the same name and ControlScope will respond to a setValue(Object). Additionally, the Class of the object that we are sending must also be defined. For example: consider two ClassObjectControl with the same ControlScope and name:

    ClassObjectControl control1 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class);

    ClassObjectControl control2 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class) {
         @Override
        public void valueChanged(Object object_val) {
            TripleAxisMessage control_val = (TripleAxisMessage) object_val;
            System.out.println("x:" + control_val.getX() + " y:" + control_val.getY() +  " z" + control_val.getZ());
        }

    };

    TripleAxisMessage msg = new TripleAxisMessage(0.1f, 0.2f, 0.3f);
    control1.setValue(msg);
 

This will cause the control2 to fire the valueChanged(Object) function with the new value, causing x:0.1 y:0.2 z:0.3 to be printed to standard output
The control can also schedule messages to be sent at a time in the future by adding the time to the message using an absolute time in the setValue(Object, double) function. For example, the message can be scheduled to execute in 1 second as follows:

control1.setValue (msg, HB.getSchedulerTime() + 1000); The Class type must be defined within the control

Values cannot be set within HappyBrackets control displays If you do require a handler on the class, use the valueChanged(Object) class

Constructor Summary

Constructors

Constructor and Description
ClassObjectControl(java.lang.Object parent_sketch, java.lang.String name, java.lang.Class<?> class_type) Constructor for abstract ClassObjectControl derive from this class

Method Summary

Modifier and Type	Method and Description
protected static java.lang.Object	createDefaultObject(java.lang.Class<?> class_type)
java.lang.Object	getValue() Get the value for the control
ClassObjectControl	setControlScope(ControlScope new_scope) Changed the scope that the control has.
ClassObjectControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object as DynamicControl.DISPLAY_TYPE We must do this in subclass
void	setValue(java.lang.Object val) set the value for the control.
void	setValue(java.lang.Object val, double scheduler_time) Identical to the setValue(Object) with the exception that the valueChanged(Object) event will be caused at the HBScheduler scheduled time passed in.
void	valueChanged(java.lang.Object control_val) Fired event that occurs when the value for the control has been set.

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

ClassObjectControl

public ClassObjectControl(java.lang.Object parent_sketch,
                          java.lang.String name,
                          java.lang.Class<?> class_type)

Constructor for abstract ClassObjectControl derive from this class

Parameters:

parent_sketch - The parent object for control

name - The name to Display

class_type - Initial value of the object. The value in the return function valueChanged(Object) will be cast

Method Detail

createDefaultObject

protected static java.lang.Object createDefaultObject(java.lang.Class<?> class_type)

getValue

public java.lang.Object getValue()

Get the value for the control

Returns:

the control value. If unable to be cast bill be a null value

valueChanged

public void valueChanged(java.lang.Object control_val)

Fired event that occurs when the value for the control has been set. For example:

     ClassObjectControl control1 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class);

     ClassObjectControl control2 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class) {
         @Override
        public void valueChanged(Object object_val) {
            TripleAxisMessage control_val = (TripleAxisMessage) object_val;
            System.out.println("x:" + control_val.getX() + " y:" + control_val.getY() +  " z" + control_val.getZ());
        }

     };

     TripleAxisMessage msg = new TripleAxisMessage(0.1f, 0.2f, 0.3f);
     control1.setValue(msg);
     

This will cause the control2 to fire the valueChanged(Object) function with the new value, causing x:0.1 y:0.2 z:0.3 to be printed to standard output

Parameters:

control_val - The class object that has been received. If the value could not be cast, the function will not be called

setValue

public void setValue(java.lang.Object val)

set the value for the control. This will notify all the listeners with same name and ControlScope. For example:

     ClassObjectControl control1 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class);

     ClassObjectControl control2 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class) {
         @Override
        public void valueChanged(Object object_val) {
            TripleAxisMessage control_val = (TripleAxisMessage) object_val;
            System.out.println("x:" + control_val.getX() + " y:" + control_val.getY() +  " z" + control_val.getZ());
        }

     };

     TripleAxisMessage msg = new TripleAxisMessage(0.1f, 0.2f, 0.3f);
     control1.setValue(msg);
     

This will cause the control2 to fire the valueChanged(Object) function with the new value, causing x:0.1 y:0.2 z:0.3 to be printed to standard output

Parameters:

val - the value to set to

setValue

public void setValue(java.lang.Object val,
                     double scheduler_time)

Identical to the setValue(Object) with the exception that the valueChanged(Object) event will be caused at the HBScheduler scheduled time passed in. For example, the following code will cause the valueChanged(Object) to be fired 1 second in the future:

     ClassObjectControl control1 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class);
     ClassObjectControl control1 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class);

     ClassObjectControl control2 = new ClassObjectControl(this, "Accel", TripleAxisMessage.class) {
         @Override
        public void valueChanged(Object object_val) {
            TripleAxisMessage control_val = (TripleAxisMessage) object_val;
            System.out.println("x:" + control_val.getX() + " y:" + control_val.getY() +  " z" + control_val.getZ());
        }

     };

     TripleAxisMessage msg = new TripleAxisMessage(0.1f, 0.2f, 0.3f);
     control1.setValue(msg, HB.getSchedulerTime() + 1000);
     

Parameters:

val - the value to set to

scheduler_time - the scheduler time this is supposed to occur at

setControlScope

public ClassObjectControl 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

Overrides:

setControlScope in class DynamicControlParent

Parameters:

new_scope - The new Control Scope

Returns:

this object

setDisplayType

public ClassObjectControl 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