LOHWChannelProxy.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: LOHWChannelProxy.h 260 2010-11-11 18:58:13Z ben.suffolk $
00033  *
00034  */
00035 
00036 #import <Cocoa/Cocoa.h>
00037 @class LOHWBridge;
00038 
00039 
00047 @interface LOHWChannelProxy : NSObject
00048 {
00049  LOHWBridge *hwBridge;
00050  unsigned int channel;
00051  int lastValue;
00052  
00053  NSMutableArray *additionalProxies;
00054 }
00055 
00056 
00066 - (id)initForChannel:(unsigned int)theChannel onBridge:(LOHWBridge *)theHWBridge;
00067 
00068 
00083 - (id)initWithXML:(NSXMLElement *)XMLElement;
00084 
00085 
00102 - (id)initWithXML:(NSXMLElement *)XMLElement offsetBy:(int)offset;
00103 
00104 
00114 + (id)proxyForChannel:(unsigned int)theChannel onBridge:(LOHWBridge *)theHWBridge;
00115 
00116 
00134 - (void)XMLIntoElement:(NSXMLElement *)parentElement;
00135 
00136 
00142 - (LOHWBridge *)hwBridge;
00143 
00144 
00150 - (unsigned int)physicalChannel;
00151 
00152 
00160 - (void)setChannelValue:(unsigned char)theValue;
00161 
00162 
00163 #pragma mark Additional Proxies
00164 
00175 - (void)addAdditionalProxy:(LOHWChannelProxy *)aProxy;
00176 
00177 
00185 - (NSArray *)additionalProxies;
00186 
00187 
00197 - (void)removeAdditionalProxy:(LOHWChannelProxy *)aProxy;
00198 
00199 
00209 - (void)removeAdditionalProxyAtIndex:(unsigned)index;
00210 
00211 
00219 - (BOOL)containsAdditionalProxy:(LOHWChannelProxy *)aProxy;
00220 
00221 
00227 - (unsigned)additionalProxiesCount;
00228 
00229 
00230 
00231 #pragma mark Deprecated Methods
00232 
00245 - (void)linkAdditionalProxy:(LOHWChannelProxy *)aProxy;
00246 
00247 
00255 - (LOHWChannelProxy *)linkedChannel;
00256 
00257 @end
00258 
00259 
00260 
00261 
00262 
00263 
00264 
00265 
00266 
00267 
00268