Plot2D_OptionFile.h

Go to the documentation of this file.

/**
\file    Plot2D_OptionFile.h
\brief   The option file class for Plot2D.

\author  Glenn D. MacGougan (GDM)
\date    2007-12-19
\since   2007-12-19

\b "LICENSE INFORMATION" \n
Copyright (c) 2007, refer to 'author' doxygen tags \n
All rights reserved. \n

Redistribution and use in source and binary forms, with or without
modification, are permitted provided the following conditions are met: \n

- Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer. \n
- Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution. \n
- The name(s) of the contributor(s) may not be used to endorse or promote 
  products derived from this software without specific prior written 
  permission. \n

THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS 
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
SUCH DAMAGE.
*/

#ifndef _PLOT2D_OPTIONFILE_H_
#define _PLOT2D_OPTIONFILE_H_

#include <string>
#include "OptionFile.h"
#include "Plot2D.h"

namespace namespace_Plot2D
{
  /// \brief   A derived option file class for the program.
  class Plot2D_OptionFile : public OptionFile
  { 
  public: 

    /// \brief    The default constructor (no data allocated yet).
    Plot2D_OptionFile();                                             

    /// \brief    The destructor.
    virtual ~Plot2D_OptionFile();

  private:

    /// \brief   The copy constructor. Disabled!
    Plot2D_OptionFile( const Plot2D_OptionFile& rhs ) {};

    /// \brief   The assignment operator. Disabled!
    void operator=(const Plot2D_OptionFile& rhs) {};

  public:

    /// \brief    Read and interpret the option file.
    /// \return   true if successful, false if error.
    bool ReadAndInterpretOptions( std::string OptionFilePath );

  public:

    struct PLOT2D_structAxisSubOption
    {
      std::string str;
      double val;
      bool useDefault;

      PLOT2D_structAxisSubOption()
        : val(0), useDefault(true)
      {}
    };

    /// \brief  The options for a plot axis.
    struct PLOT2D_structAxisInfo
    {
      bool isGridOn;               //!< Are the dashed grid lines on.
      std::string label;           //!< The axis label.
      PLOT2D_structAxisSubOption lower_limit; //!< The lower plotting limit.
      PLOT2D_structAxisSubOption upper_limit; //!< The upper plotting limit.
      PLOT2D_structAxisSubOption tick_start;  //!< The start xtick label value.
      PLOT2D_structAxisSubOption tick_size;   //!< The xtick size value.
      PLOT2D_structAxisSubOption tick_end;    //!< The end xtick label value.

      PLOT2D_structAxisInfo()
        : isGridOn(true)
      {}
    };

    std::string m_OutputFileName; //!< The name of the output bitmap file.

    int m_NumberOfSeries;  //!< The total number of series to plot.
    int m_PlotSize_Width;  //!< The width of the plot [cm].
    int m_PlotSize_Height; //!< the height of the plot [cm].

    std::string m_Title;   //!< The plot title.

    PLOT2D_structAxisInfo m_xAxis; //!< The x-axis plot information.

    PLOT2D_structAxisInfo m_yAxis; //!< The y-axis plot information.

    bool m_PlotStatistics;  //!< A boolean indicating if statistics are to be included in the figure.

    bool m_PlaceLabelBelowThePlot; //!< Where to place the labels and statistics? Below or to the right.

    CPLOT_enumColor m_FigureBackgroundColor; //!< The figure background color.

    /** 
    \brief  A boolean indicating if the special GPS x axis label is to be used.
    Enabling X_UseGPSLabel assumes that the X part of the 
    series is a GPS time of week, (0-604800 s), and will
    compute the corresponding UTC time and include it 
    below each xtick.
    */   
    bool m_UseGPSLabel;  

    int m_UTCOffset; //!< The GPS/UTC offset (always +ve).

    /** \brief  a y-axis label for the right side of the figure.

    Data can be plotted with respect to y ticks on the right 
    hand side of the plot window. 
    For example, plot elevation angle (0-90, left side y ticks) 
    and plot azimuth angle (-180-180, right side y ticks). 

    \code
    rhs_ytick = lhs_ytick * scale_factor + offset
    e.g.
    Y_Label,              = "Elevation (deg)"
    Y_RightYLabel,        = "Azimuth (deg)"
    Y_RightYOffset,       = -180
    Y_RightYScaleFactor,  = 4
    \endcode
    */
    std::string m_rightY_label;
    double m_rightY_scale_factor; //!< Scale the lhs y ticks by this value for the rhs ticks.
    double m_rightY_offset;       //!< Offset the rhs y ticks by this value after scaling.

    /// \brief  The array of series options. Up to 12 series can be plotted.
    PLOT2D_structSeriesInfo m_Series[12];    


    /// Determine the color enum from the string value.
    bool DetermineColorFromString( CPLOT_enumColor &color, std::string color_str );

  private:

    /// Determine if a value is used or the item uses a default.
    void DetermineValueOrDefault( PLOT2D_structAxisSubOption &s );

  };

} // end namespace

#endif // _PLOT2D_OPTIONFILE_H_