namespace_Plot2D::Plot2D_OptionFile Class Reference

#include <Plot2D_OptionFile.h>

Inheritance diagram for namespace_Plot2D::Plot2D_OptionFile:

OptionFile

Detailed Description

A derived option file class for the program.

Definition at line 48 of file Plot2D_OptionFile.h.


Public Member Functions

 Plot2D_OptionFile ()
 The default constructor (no data allocated yet).
virtual ~Plot2D_OptionFile ()
 The destructor.
bool ReadAndInterpretOptions (std::string OptionFilePath)
 Read and interpret the option file.
bool DetermineColorFromString (CPLOT_enumColor &color, std::string color_str)
 Determine the color enum from the string value.

Data Fields

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.
bool m_UseGPSLabel
 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.
int m_UTCOffset
 The GPS/UTC offset (always +ve).
std::string m_rightY_label
 a y-axis label for the right side of the figure.
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.
PLOT2D_structSeriesInfo m_Series [12]
 The array of series options. Up to 12 series can be plotted.

Data Structures

struct  PLOT2D_structAxisInfo
 The options for a plot axis. More...

Constructor & Destructor Documentation

namespace_Plot2D::Plot2D_OptionFile::Plot2D_OptionFile (  ) 

The default constructor (no data allocated yet).

Definition at line 49 of file Plot2D_OptionFile.cpp.

namespace_Plot2D::Plot2D_OptionFile::~Plot2D_OptionFile (  )  [virtual]

The destructor.

Definition at line 44 of file Plot2D_OptionFile.cpp.


Member Function Documentation

bool namespace_Plot2D::Plot2D_OptionFile::ReadAndInterpretOptions ( std::string  OptionFilePath  ) 

Read and interpret the option file.

Returns:
true if successful, false if error.

Definition at line 75 of file Plot2D_OptionFile.cpp.

bool namespace_Plot2D::Plot2D_OptionFile::DetermineColorFromString ( CPLOT_enumColor color,
std::string  color_str 
)

Determine the color enum from the string value.

Definition at line 252 of file Plot2D_OptionFile.cpp.


Field Documentation

std::string namespace_Plot2D::Plot2D_OptionFile::m_OutputFileName

The name of the output bitmap file.

Definition at line 101 of file Plot2D_OptionFile.h.

int namespace_Plot2D::Plot2D_OptionFile::m_NumberOfSeries

The total number of series to plot.

Definition at line 103 of file Plot2D_OptionFile.h.

int namespace_Plot2D::Plot2D_OptionFile::m_PlotSize_Width

The width of the plot [cm].

Definition at line 104 of file Plot2D_OptionFile.h.

int namespace_Plot2D::Plot2D_OptionFile::m_PlotSize_Height

the height of the plot [cm].

Definition at line 105 of file Plot2D_OptionFile.h.

std::string namespace_Plot2D::Plot2D_OptionFile::m_Title

The plot title.

Definition at line 107 of file Plot2D_OptionFile.h.

PLOT2D_structAxisInfo namespace_Plot2D::Plot2D_OptionFile::m_xAxis

The x-axis plot information.

Definition at line 109 of file Plot2D_OptionFile.h.

PLOT2D_structAxisInfo namespace_Plot2D::Plot2D_OptionFile::m_yAxis

The y-axis plot information.

Definition at line 111 of file Plot2D_OptionFile.h.

bool namespace_Plot2D::Plot2D_OptionFile::m_PlotStatistics

A boolean indicating if statistics are to be included in the figure.

Definition at line 113 of file Plot2D_OptionFile.h.

bool namespace_Plot2D::Plot2D_OptionFile::m_PlaceLabelBelowThePlot

Where to place the labels and statistics? Below or to the right.

Definition at line 115 of file Plot2D_OptionFile.h.

CPLOT_enumColor namespace_Plot2D::Plot2D_OptionFile::m_FigureBackgroundColor

The figure background color.

Definition at line 117 of file Plot2D_OptionFile.h.

bool namespace_Plot2D::Plot2D_OptionFile::m_UseGPSLabel

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.

Definition at line 126 of file Plot2D_OptionFile.h.

int namespace_Plot2D::Plot2D_OptionFile::m_UTCOffset

The GPS/UTC offset (always +ve).

Definition at line 128 of file Plot2D_OptionFile.h.

std::string namespace_Plot2D::Plot2D_OptionFile::m_rightY_label

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).

    rhs_ytick = lhs_ytick * scale_factor + offset
    e.g.
    Y_Label,              = "Elevation (deg)"
    Y_RightYLabel,        = "Azimuth (deg)"
    Y_RightYOffset,       = -180
    Y_RightYScaleFactor,  = 4

Definition at line 146 of file Plot2D_OptionFile.h.

double namespace_Plot2D::Plot2D_OptionFile::m_rightY_scale_factor

Scale the lhs y ticks by this value for the rhs ticks.

Definition at line 147 of file Plot2D_OptionFile.h.

double namespace_Plot2D::Plot2D_OptionFile::m_rightY_offset

Offset the rhs y ticks by this value after scaling.

Definition at line 148 of file Plot2D_OptionFile.h.

PLOT2D_structSeriesInfo namespace_Plot2D::Plot2D_OptionFile::m_Series[12]

The array of series options. Up to 12 series can be plotted.

Definition at line 151 of file Plot2D_OptionFile.h.


The documentation for this class was generated from the following files: