summaryrefslogtreecommitdiffstats
path: root/libraries/oscP5/src/oscP5/OscArgument.java
blob: 9b09248e194c0c938f66bce8ed38b9803865087e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/**
 * An OSC (Open Sound Control) library for processing.
 *
 * (c) 2004-2012
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA  02111-1307  USA
 * 
 * @author		Andreas Schlegel http://www.sojamo.de
 * @modified	12/23/2012
 * @version		0.9.9
 */


package oscP5;

/**
 * an osc argument contains one value of values from a received osc message.
 * you can convert the value into the required format, e.g. from Object to int
 * theOscMessage.get(0).intValue();
 * @related OscMessage
 * @example oscP5oscArgument
 */
public class OscArgument {
	protected Object value;

    /**
     * @invisible
     */
    public OscArgument() {}

	/**
         * get the int value of the osc argument.
	 * @return int
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public int intValue() {
		return ((Integer) value).intValue();
	}

	/**
	 * get the char value of the osc argument.
	 * @return char
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public char charValue() {
		return ((Character) value).charValue();
	}

	/**
	 * get the float value of the osc argument.
	 * @return float
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public float floatValue() {
		return ((Float) value).floatValue();
	}

	/**
	 * get the double value of the osc argument.
	 * @return double
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public double doubleValue() {
		return ((Double) value).doubleValue();
	}

	/**
	 * get the long value of the osc argument.
	 * @return long
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public long longValue() {
		return ((Long) value).longValue();
	}

	/**
	 * get the boolean value of the osc argument.
	 * @return boolean
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public boolean booleanValue() {
		return ((Boolean) value).booleanValue();
	}

        /**
         * get the String value of the osc argument.
         * @return String
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
         */
        public String stringValue() {
         return ((String) value);
        }


	/**
	 *
	 * @return String
	 */
	public String toString() {
		return ((String) value);
	}

	/**
	 * get the byte array of the osc argument.
	 * @return byte[]
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
	 */
	public byte[] bytesValue() {
		return ((byte[]) value);
	}

        /**
         * get the byte array (blob) of the osc argument.
         * @return byte[]
         * @related intValue ( )
         * @related floatValue ( )
         * @related charValue ( )
         * @related stringValue ( )
         * @related doubleValue ( )
         * @related longValue ( )
         * @related booleanValue ( )
         * @related bytesValue ( )
         * @related blobValue ( )
         * @example oscP5parsing
         */
        public byte[] blobValue() {
                return ((byte[]) value);
        }


	/**
	 *
	 * @return int[]
	 */
	public int[] midiValue() {
		int[] myInt = new int[4];
		byte[] myByte = (byte[]) value;
		for (int i = 0; i < 4; i++) {
			myInt[i] = (int) (myByte[i]);
		}
		return (myInt);
	}
}