LOCommandToken.h

00001 /*
00002  *
00003  * Copyright (c) 2006,2005,2004 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: LOCommandToken.h 241 2009-10-23 16:27:41Z ben.suffolk $
00033  *
00034  *******************************************************************************
00035  *
00036  * History :-
00037  *
00038  * <Name>  <Date>
00039  *
00040  * <Comment>
00041  * 
00042  *******************************************************************************
00043 */
00044 
00045 
00046 
00047 #import <Cocoa/Cocoa.h>
00048 
00049 
00056 typedef enum LOCommandTokenType
00057               {
00058               LOCommandTokenTypeNone = 0,
00059               LOCommandTokenTypeNumber,
00060               LOCommandTokenTypeThru,
00061               LOCommandTokenTypeMinus,
00062               LOCommandTokenTypePlus,
00063               LOCommandTokenTypeAt,
00064               LOCommandTokenTypeOn,
00065               LOCommandTokenTypeOff,
00066               LOCommandTokenTypeSolo,
00067               LOCommandTokenTypeRelease,
00068               LOCommandTokenTypeLast,
00069               LOCommandTokenTypeDot,
00070               LOCommandTokenTypeCustom = 0x80
00071               } LOCommandTokenType;
00072 
00073 
00081 @interface LOCommandToken : NSObject
00082 {
00083  LOCommandTokenType type; 
00084  float value; 
00085  BOOL leadingZero; 
00086  BOOL hasDP;       
00087  BOOL overflow;    
00088  int places;       
00089  
00090  NSString *stringValue; 
00091 }
00092 
00093 
00099 + (LOCommandToken *)thruCommandToken;
00100 
00101 
00107 + (LOCommandToken *)plusCommandToken;
00108 
00109 
00115 + (LOCommandToken *)minusCommandToken;
00116 
00117 
00123 + (LOCommandToken *)atCommandToken;
00124 
00125 
00131 + (LOCommandToken *)onCommandToken;
00132 
00133 
00139 + (LOCommandToken *)offCommandToken;
00140 
00141 
00147 + (LOCommandToken *)soloCommandToken;
00148 
00149 
00155 + (LOCommandToken *)releaseCommandToken;
00156 
00157 
00163 + (LOCommandToken *)lastCommandToken;
00164 
00165 
00171 + (LOCommandToken *)dotCommandToken;
00172 
00173 
00179 + (LOCommandToken *)numberCommandTokenWithVaule:(float)theValue;
00180 
00181 
00187 - (id)initWithType:(LOCommandTokenType)theType;
00188 
00189 
00195 - (id)initWithType:(LOCommandTokenType)theType andValue:(float)theValue;
00196 
00197 
00203 - (LOCommandTokenType)type;
00204 
00205 
00211 - (void)setType:(LOCommandTokenType)newType;
00212 
00213 
00221 - (float)value;
00222 
00223 
00232 - (void)setValue:(float)theValue;
00233 
00234 
00244 - (void)setValue:(float)theValue withPlaces:(int)thePlaces;
00245 
00246 
00254 - (BOOL)hasLeadingZero;
00255 
00256 
00264 - (void)setLeadingZero:(BOOL)flag;
00265 
00266 
00274 - (BOOL)hasDP;
00275 
00276 
00284 - (void)setDP:(BOOL)flag;
00285 
00286 
00295 - (BOOL)didOverflow;
00296 
00297 
00305 - (void)setOverflow:(BOOL)flag;
00306 
00307 
00320 - (NSString *)stringValue;
00321 
00322 
00331 - (void)setStringValue:(NSString *)string;
00332 
00333 
00334 @end
00335 
00336 
00337 
00338 
00339 
00340 
00341 
00342 
00343 
00344 
00345 
00346 
00347 
00348 
00349 
00350 
00351