00001 /** 00002 \file gpsppssync_OptionFile.h 00003 \brief The option file for gpsppssync. 00004 00005 \author Glenn D. MacGougan (GDM) 00006 \date 2008-12-22 00007 \since 2008-12-22 00008 00009 \b "LICENSE INFORMATION" \n 00010 Copyright (c) 2008 - All rights reserved. \n 00011 00012 Redistribution and use in source and binary forms, with or without 00013 modification, are permitted provided the following conditions are met: \n 00014 00015 - Redistributions of source code must retain the above copyright 00016 notice, this list of conditions and the following disclaimer. \n 00017 - Redistributions in binary form must reproduce the above copyright 00018 notice, this list of conditions and the following disclaimer in the 00019 documentation and/or other materials provided with the distribution. \n 00020 - The name(s) of the contributor(s) may not be used to endorse or promote 00021 products derived from this software without specific prior written 00022 permission. \n 00023 00024 THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS 00025 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 00026 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00027 DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 00028 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 00029 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00030 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00031 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00032 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 00033 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00034 SUCH DAMAGE. 00035 */ 00036 00037 00038 #ifndef _GPSPPSSYNC_OPTIONFILE_H_ 00039 #define _GPSPPSSYNC_OPTIONFILE_H_ 00040 00041 #include <string> // for std::string 00042 #include "OptionFile.h" 00043 00044 /// \brief A derived option file class for the program. 00045 class gpsppssync_OptionFile : public OptionFile 00046 { 00047 public: 00048 00049 /// \brief The default constructor (no data allocated yet). 00050 gpsppssync_OptionFile(); 00051 00052 /// \brief The destructor. 00053 virtual ~gpsppssync_OptionFile(); 00054 00055 private: 00056 00057 /// \brief The copy constructor. Disabled! 00058 gpsppssync_OptionFile( const gpsppssync_OptionFile& rhs ) {}; 00059 00060 /// \brief The assignment operator. Disabled! 00061 void operator=(const gpsppssync_OptionFile& rhs) {}; 00062 00063 public: 00064 00065 /// \brief Read and interpret the option file. 00066 /// \return true if successful, false if error. 00067 bool ReadAndInterpretOptions( std::string OptionFilePath ); 00068 00069 public: 00070 00071 /// The path to the option file. 00072 std::string m_OptionFilePath; 00073 00074 /// The serial port number. 00075 unsigned m_SerialPortNumber; 00076 00077 /// A boolean to indicate if the pulse per second test is to be performed. 00078 bool m_PerformPPSTest; 00079 00080 /// A boolean to indicate if 40s of time output and audible dings are to be 00081 /// used for manual synchronization comparison. 00082 bool m_AllowTimeForHyperTerminalComparison; 00083 00084 /// The receiver type. 00085 std::string m_ReceiverType; 00086 00087 /// The receiver serial port number on which data is collected. 00088 unsigned m_ReceiverSerialPortNumber; 00089 }; 00090 00091 #endif // _GPSPPSSYNC_OPTIONFILE_H_