001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.hardware.compass;
031
032import java.util.regex.Matcher;
033import java.util.regex.Pattern;
034
035/**
036 *      Parser for strings of data from the OceanServer serial compass.
037 * 
038 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *      
040 *      @created 13 Jul 2011
041 */
042public class OS5000_0x01_Parser
043{
044        // $Chhh.hPpp.pRrr.rTtt.tMx0.000My0.000Mz0.000Ax000.0Ay000.0Az000.0*cc
045        private final static Pattern COMPASS = Pattern.compile( "C(\\d+\\.\\d+)" );
046        private final static Pattern PITCH = Pattern.compile( "P(-??\\d+\\.\\d+)" );
047        private final static Pattern ROLL = Pattern.compile( "R(-??\\d+\\.\\d+)" );
048        private final static Pattern TEMPERATURE = Pattern.compile( "T(-??\\d+\\.\\d+)" );
049        private final static Pattern MX = Pattern.compile( "Mx(-??\\d+\\.\\d+)" );
050        private final static Pattern MY = Pattern.compile( "My(-??\\d+\\.\\d+)" );
051        private final static Pattern MZ = Pattern.compile( "Mz(-??\\d+\\.\\d+)" );
052        private final static Pattern AX = Pattern.compile( "Ax(-??\\d+\\.\\d+)" );
053        private final static Pattern AY = Pattern.compile( "Ay(-??\\d+\\.\\d+)" );
054        private final static Pattern AZ = Pattern.compile( "Az(-??\\d+\\.\\d+)" );
055
056        /**
057         *      Given a line of data, parses the line into a {@link CompassData} object.
058         * 
059         *  @param line The line to parse.
060         *  @return A {@link CompassData} object
061         */
062        public static CompassData parseLine( String line )
063        {
064                CompassData data = new CompassData();
065
066                data.compass = parse( COMPASS, line );
067                data.pitch = parse( PITCH, line );
068                data.roll = parse( ROLL, line );
069                data.temperature = parse( TEMPERATURE, line );
070                data.mx = parse( MX, line );
071                data.my = parse( MY, line );
072                data.mz = parse( MZ, line );
073                data.ax = parse( AX, line );
074                data.ay = parse( AY, line );
075                data.az = parse( AZ, line );
076
077                return data;
078        }
079
080        /**
081         *      Helper function to parse individual lines.
082         * 
083         *  @param p The pattern to match against
084         *  @param line The line to parse.
085         *  @return a double value parsed out of the string
086         */
087        private static double parse( Pattern p, String line )
088        {
089                Matcher m = p.matcher( line );
090                if( m.find() ) return Double.parseDouble( m.group( 1 ) );
091                return 0;
092        }
093}