Plot2D_OptionFile.cpp

Go to the documentation of this file.

/**
\file    Plot2D_OptionFile.cpp
\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.
*/

#include <memory.h>
#include "Plot2D_OptionFile.h"
#include "StdStringUtils.h"

namespace namespace_Plot2D
{
  Plot2D_OptionFile::~Plot2D_OptionFile()
  {
  }


  Plot2D_OptionFile::Plot2D_OptionFile()
    : 
    m_NumberOfSeries(1),
    m_PlotSize_Width(11),
    m_PlotSize_Height(9),
    m_PlotStatistics(true),
    m_PlaceLabelBelowThePlot(false),
    m_FigureBackgroundColor(CPLOT_WHITE),
    m_UseGPSLabel(false),
    m_UTCOffset(false),
    m_rightY_scale_factor(1.0),
    m_rightY_offset(0)
  {
    int i;
    for( i = 0; i < 12; i++ )
    {
      m_Series[i].Color = (CPLOT_enumColor)(i+2);
      m_Series[i].IsConnected = true;
      m_Series[i].MarkOutlierData = true;
      m_Series[i].Precision = 6;    
      m_Series[i].X_Column = 0;
      m_Series[i].Y_Column = i+1;
    }    
    m_OutputFileName = "plot2d.bmp";
  }

  bool Plot2D_OptionFile::ReadAndInterpretOptions( const std::string OptionFilePath )
  {
    int i;
    char buffer[256];
    std::string tmpstr;
    std::string str;
    std::string color_str;
    if( !ReadOptionFile( OptionFilePath ) )
      return false;

    if( !GetValue( "OutputFileName", m_OutputFileName ) )
      return false;

    if( !GetValue( "NumberOfSeries", m_NumberOfSeries ) )
      return false;
    if( m_NumberOfSeries <= 0 )
      return false;

    if( !GetValue( "PlotSize_Width", m_PlotSize_Width ) )
      return false;
    if( m_PlotSize_Width <= 0 || m_PlotSize_Width > 30 )
      return false;

    if( !GetValue( "PlotSize_Height", m_PlotSize_Height ) )
      return false;
    // do not allow very large image generation
    if( m_PlotSize_Height <= 0 || m_PlotSize_Height > 30 )
      return false;

    if( m_NumberOfSeries > 12 )
      return false;

    GetValue( "Title", m_Title );

    GetValue( "X_IsGridOn", m_xAxis.isGridOn ); 
    GetValue( "X_Label", m_xAxis.label );
    GetValue( "X_LowerLimit", m_xAxis.lower_limit.str );
    GetValue( "X_UpperLimit", m_xAxis.upper_limit.str );
    GetValue( "X_TickStart", m_xAxis.tick_start.str );
    GetValue( "X_TickSize", m_xAxis.tick_size.str );
    GetValue( "X_TickEnd", m_xAxis.tick_end.str );

    DetermineValueOrDefault( m_xAxis.lower_limit );
    DetermineValueOrDefault( m_xAxis.upper_limit );
    DetermineValueOrDefault( m_xAxis.tick_start );
    DetermineValueOrDefault( m_xAxis.tick_size );
    DetermineValueOrDefault( m_xAxis.tick_end );

    GetValue( "Y_IsGridOn", m_yAxis.isGridOn ); 
    GetValue( "Y_Label", m_yAxis.label );
    GetValue( "Y_LowerLimit", m_yAxis.lower_limit.str );
    GetValue( "Y_UpperLimit", m_yAxis.upper_limit.str );
    GetValue( "Y_TickStart", m_yAxis.tick_start.str );
    GetValue( "Y_TickSize", m_yAxis.tick_size.str );
    GetValue( "Y_TickEnd", m_yAxis.tick_end.str );

    DetermineValueOrDefault( m_yAxis.lower_limit );
    DetermineValueOrDefault( m_yAxis.upper_limit );
    DetermineValueOrDefault( m_yAxis.tick_start );
    DetermineValueOrDefault( m_yAxis.tick_size );
    DetermineValueOrDefault( m_yAxis.tick_end );

    GetValue( "PlotStatistics", m_PlotStatistics );

    GetValue( "PlaceLabelBelowThePlot", m_PlaceLabelBelowThePlot );

    if( GetValue( "FigureBackgroundColor", color_str ) && color_str.length() > 0 )
    {
      DetermineColorFromString( m_FigureBackgroundColor, color_str );
    }

    GetValue( "X_UseGPSLabel", m_UseGPSLabel );

    if( m_UseGPSLabel )
    {
      m_UTCOffset = 0;
      GetValue( "X_GPSUTCOffset", m_UTCOffset );
    }

    GetValue( "Y_RightYLabel", m_rightY_label );
    if( !m_rightY_label.empty() )
    {
      GetValue( "Y_RightYScaleFactor", m_rightY_scale_factor );
      GetValue( "Y_RightYOffset", m_rightY_offset );
    }


    for( i = 0; i < m_NumberOfSeries; i++ )
    {
      sprintf( buffer, "Series%d_", i+1 );
      str = buffer;

      tmpstr = str;
      tmpstr += "DataPath";
      if( !GetValue( tmpstr, m_Series[i].DataPath ) )
        return false;

      tmpstr = str;
      tmpstr += "X_Column";
      if( !GetValue( tmpstr, m_Series[i].X_Column ) )
        return false;
      if( m_Series[i].X_Column == 0 )
        return false;
      m_Series[i].X_Column--; // make zero based index

      tmpstr = str;
      tmpstr += "Y_Column";
      if( !GetValue( tmpstr, m_Series[i].Y_Column ) )
        return false;
      if( m_Series[i].Y_Column == 0 )
        return false;
      m_Series[i].Y_Column--; // make zero based index

      tmpstr = str;
      tmpstr += "IsConnected";
      GetValue( tmpstr, m_Series[i].IsConnected );

      tmpstr = str;
      tmpstr += "Color";
      if( GetValue( tmpstr, color_str ) && color_str.length() > 0 )
      {
        DetermineColorFromString( m_Series[i].Color, color_str );
      }
      else
      {
        if( i == 0 )
          m_Series[i].Color = CPLOT_BLUE;
        else
          m_Series[i].Color = (CPLOT_enumColor)(m_Series[i-1].Color+1);

      }
        
      tmpstr = str;
      tmpstr += "Label";
      GetValue( tmpstr, m_Series[i].Label );

      tmpstr = str;
      tmpstr += "Units";
      GetValue( tmpstr, m_Series[i].Units );

      if( m_PlotStatistics )
      {
        tmpstr = str;
        tmpstr += "Precision";
        GetValue( tmpstr, m_Series[i].Precision );
      }

      tmpstr = str;
      tmpstr += "MarkOutlierData";
      GetValue( tmpstr, m_Series[i].MarkOutlierData );

      if( !m_rightY_label.empty() )
      {
        tmpstr = str;
        tmpstr += "UsesRightYLabel";
        GetValue( tmpstr, m_Series[i].UsesRightYLabel );
      }
    }
    
    return true;
  }

  void Plot2D_OptionFile::DetermineValueOrDefault( PLOT2D_structAxisSubOption &s )
  {
    s.useDefault = true;
    if( !s.str.empty() )
    {
      StdStringUtils::MakeUpper( s.str );

      if( s.str.compare("DEFAULT") != 0 )
      {
        if( StdStringUtils::GetDouble( s.str, s.val ) )
          s.useDefault = false;
      }
    }
  }

  bool Plot2D_OptionFile::DetermineColorFromString( CPLOT_enumColor &color, std::string color_str )
  {
    StdStringUtils::MakeLower( color_str );
    
    if( color_str.compare( "white" ) == 0 )
      color = CPLOT_WHITE;
    else if( color_str.compare( "black" ) == 0 )
      color = CPLOT_BLACK;
    else if( color_str.compare( "blue" ) == 0 )
      color = CPLOT_BLUE;
    else if( color_str.compare( "green" ) == 0 )
      color = CPLOT_GREEN;
    else if( color_str.compare( "purple" ) == 0 )
      color = CPLOT_PURPLE;
    else if( color_str.compare( "magenta" ) == 0 )
      color = CPLOT_MAGENTA;
    else if( color_str.compare( "darkblue" ) == 0 )
      color = CPLOT_DARKBLUE;
    else if( color_str.compare( "indianred" ) == 0 )
      color = CPLOT_INDIANRED;
    else if( color_str.compare( "babyblue" ) == 0 )
      color = CPLOT_BABYBLUE;
    else if( color_str.compare( "paislyblue" ) == 0 )
      color = CPLOT_PAISLYBLUE;
    else if( color_str.compare( "lightpurple" ) == 0 )
      color = CPLOT_LIGHTPURPLE;
    else if( color_str.compare( "darkpurple" ) == 0 )
      color = CPLOT_DARKPURPLE;
    else if( color_str.compare( "greypurple" ) == 0 )
      color = CPLOT_GREYPURPLE;
    else if( color_str.compare( "brown" ) == 0 )
      color = CPLOT_BROWN;
    else if( color_str.compare( "red" ) == 0 )
      color = CPLOT_RED;
    else if( color_str.compare( "pink" ) == 0 )
      color = CPLOT_PINK;
    else if( color_str.compare( "yellow" ) == 0 )
      color = CPLOT_YELLOW;
    else if( color_str.compare( "orange" ) == 0 )
      color = CPLOT_ORANGE;
    else if( color_str.compare( "cyan" ) == 0 )
      color = CPLOT_CYAN;
    else if( color_str.compare( "limegreen" ) == 0 )
      color = CPLOT_LIMEGREEN;
    else if( color_str.compare( "grey" ) == 0 )
      color = CPLOT_GREY;
    else if( color_str.compare( "lightgrey" ) == 0 )
      color = CPLOT_LIGHTGREY;
    else
      color = CPLOT_BLACK;

    return true;
  }

} // end of namespace Plot2D;