LODMXResponse.h

00001 /*
00002  *
00003  * Copyright (c) 2006, Ben Suffolk <ben@usbdmx.com>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without 
00007  * modification, are permitted provided that the following conditions are met:
00008  *
00009  * 1. Redistributions of source code must retain the above copyright notice,
00010  *    this list of conditions and the following disclaimer.
00011  *
00012  * 2. Redistributions in binary form must reproduce the above copyright notice,
00013  *    this list of conditions and the following disclaimer in the documentation
00014  *    and/or other materials provided with the distribution.
00015  *
00016  * 3. Neither the name of the usbdmx.com web site nor the names of its 
00017  *    contributors may be used to endorse or promote products derived from this
00018  *    software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
00021  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
00022  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
00023  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
00024  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
00025  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
00026  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
00029  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030  * POSSIBILITY OF SUCH DAMAGE.
00031  *
00032  * $Id: LODMXResponse.h 186 2007-09-28 13:33:35Z ben.suffolk $
00033  *
00034  */
00035 
00036 #import <Cocoa/Cocoa.h>
00037 
00038 
00039 @class LOHWBridge;
00040 
00049 @interface LODMXResponse : NSObject
00050 {
00051  unsigned char code;   
00052  unsigned int channel; 
00053  unsigned char value;  
00054  LOHWBridge *hwBridge; 
00055 }
00056 
00057 
00069 - (id)initWithCode:(unsigned char)theCode onBridge:(LOHWBridge *)theBridge;
00070 
00071 
00085 - (id)initWithCode:(unsigned char)theCode andChannel:(unsigned int)theChannel onBridge:(LOHWBridge *)theBridge;
00086 
00087 
00103 - (id)initWithCode:(unsigned char)theCode andChannel:(unsigned int)theChannel withValue:(unsigned char)theValue onBridge:(LOHWBridge *)theBridge;
00104 
00105 
00117 + (id)responseWithCode:(unsigned char)theCode onBridge:(LOHWBridge *)theBridge;
00118 
00119 
00134 + (id)responseWithCode:(unsigned char)theCode andChannel:(unsigned int)theChannel onBridge:(LOHWBridge *)theBridge;
00135 
00136 
00153 + (id)responseWithCode:(unsigned char)theCode andChannel:(unsigned int)theChannel withValue:(unsigned char)theValue onBridge:(LOHWBridge *)theBridge;
00154 
00155 
00163 - (LOHWBridge *)hwBridge;
00164 
00165 
00173 - (unsigned char)code;
00174 
00175 
00183 - (unsigned int)channel;
00184 
00185 
00193 - (unsigned char)value;
00194 
00195 
00203 - (NSString *)codeAsString;
00204 
00205 @end
00206 
00207 
00208 
00209 
00210 
00211 
00212 
00213 
00214 
00215 
00216 
00217 
00218 
00219