front_processing/extern/TUIO_JAVA/src/com/illposed/osc/OSCMessage.java
author bastiena
Thu, 22 Mar 2012 18:15:53 +0100
changeset 9 0f44b7360c8d
parent 0 6fefd4afe506
child 10 925b7ee746e3
permissions -rw-r--r--
Installer updated files charset set to UTF-8 without tabs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
     1
/**
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     2
 * @author cramakrishnan
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     3
 *
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     4
 * Copyright (C) 2003, C. Ramakrishnan / Illposed Software
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     5
 * All rights reserved.
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     6
 * 
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     7
 * See license.txt (or license.rtf) for license information.
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     8
 * 
6fefd4afe506 First Import
bastiena
parents:
diff changeset
     9
 * 
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    10
 * An simple (non-bundle) OSC message. An OSC message is made up of 
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    11
 *     an address (who is this message sent to)
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    12
 *     and arguments (what is the contents of this message).
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    13
 */
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    14
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    15
package com.illposed.osc;
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    16
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    17
import java.util.Enumeration;
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    18
import java.util.Vector;
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    19
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    20
import com.illposed.osc.utility.*;
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    21
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    22
public class OSCMessage extends OSCPacket {
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    23
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    24
    protected String address;
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    25
    protected Vector<Object> arguments;
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    26
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    27
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    28
     * Create an empty OSC Message
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    29
     * In order to send this osc message, you need to set the address
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    30
     * and, perhaps, some arguments.
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    31
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    32
    public OSCMessage() {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    33
        super();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    34
        arguments = new Vector<Object>();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    35
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    36
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    37
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    38
     * Create an OSCMessage with an address already initialized
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    39
     * @param newAddress The recepient of this OSC message
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    40
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    41
    public OSCMessage(String newAddress) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    42
        this(newAddress, null);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    43
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    44
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    45
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    46
     * Create an OSCMessage with an address and arguments already initialized
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    47
     * @param newAddress    The recepient of this OSC message
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    48
     * @param newArguments  The data sent to the receiver
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    49
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    50
    public OSCMessage(String newAddress, Object[] newArguments) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    51
        super();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    52
        address = newAddress;
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    53
        if (null != newArguments) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    54
            arguments = new Vector<Object>(newArguments.length);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    55
            for (int i = 0; i < newArguments.length; i++) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    56
                arguments.add(newArguments[i]);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    57
            }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    58
        } else
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    59
            arguments = new Vector<Object>();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    60
        init();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    61
    }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    62
    
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    63
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    64
     * @return the address of this OSC Message
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    65
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    66
    public String getAddress() {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    67
        return address;
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    68
    }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    69
    
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    70
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    71
     * Set the address of this messsage
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    72
     * @param anAddress
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    73
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    74
    public void setAddress(String anAddress) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    75
        address = anAddress;
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    76
    }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    77
    
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    78
    public void addArgument(Object argument) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    79
        arguments.add(argument);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    80
    }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    81
    
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    82
    public Object[] getArguments() {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    83
        return arguments.toArray();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    84
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    85
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    86
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    87
     * @param stream OscPacketByteArrayConverter
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    88
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    89
    protected void computeAddressByteArray(OSCJavaToByteArrayConverter stream) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    90
        stream.write(address);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    91
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
    92
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    93
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    94
     * @param stream OscPacketByteArrayConverter
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    95
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    96
    protected void computeArgumentsByteArray(OSCJavaToByteArrayConverter stream) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    97
        // SC starting at version 2.2.10 wants a comma at the beginning
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    98
        // of the arguments array.
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
    99
        stream.write(',');
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   100
        if (null == arguments)
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   101
            return;
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   102
        stream.writeTypes(arguments);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   103
        Enumeration enm = arguments.elements();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   104
        while (enm.hasMoreElements()) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   105
            stream.write(enm.nextElement());
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   106
        }
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   107
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
   108
9
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   109
    /**
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   110
     * @param stream OscPacketByteArrayConverter
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   111
     */
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   112
    protected void computeByteArray(OSCJavaToByteArrayConverter stream) {
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   113
        computeAddressByteArray(stream);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   114
        computeArgumentsByteArray(stream);
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   115
        byteArray = stream.toByteArray();
0f44b7360c8d Installer updated
bastiena
parents: 0
diff changeset
   116
    }
0
6fefd4afe506 First Import
bastiena
parents:
diff changeset
   117
6fefd4afe506 First Import
bastiena
parents:
diff changeset
   118
}