---

TxLinePlotDesc Class Reference

-- Contains description of parameters required for a line plot. More...

#include <TxLinePlotDesc.h>

List of all members.

Public Methods
	TxLinePlotDesc ()
	default constructor. More...
	TxLinePlotDesc (const TxLinePlotData *)
	typical constructor; includes pointer to class holding the plot data. More...
	TxLinePlotDesc (const TxLinePlotData *, const TXSTD::string &, const TXSTD::string &, const TXSTD::string &, int, int)
	constructor specifying pointer to class holding the plot data, plus (in order) the x label, the y label, the plot title, an integer to access the x (horizontal) data, and an integer to access the y (vertical) data. More...
	TxLinePlotDesc (const TxLinePlotDesc &)
	copy constructor. More...
const TxLinePlotDesc&	operator= (const TxLinePlotDesc &)
	assignment operator. More...
virtual	~TxLinePlotDesc ()
	virtual destructor. More...
const TXSTD::string	getTitle () const
	get title of plot. More...
const TXSTD::string	getXLabel () const
	get (horizontal) x label of plot. More...
const TXSTD::string	getYLabel () const
	get (vertical) y label of plot. More...
double	getXMin () const
	get minimum value for x (horizontal) data. More...
double	getXMax () const
	get maximum value for x (horizontal) data. More...
double	getYMin () const
	get minimum value for y (vertical) data. More...
double	getYMax () const
	get maximum value for y (vertical) data. More...
double	getXMinPlot () const
	get minimum value for (horizontal) x-axis of plot. More...
double	getXMaxPlot () const
	get maximum value for (horizontal) x-axis of plot. More...
double	getYMinPlot () const
	get minimum value for (vertical) y-axis of plot. More...
double	getYMaxPlot () const
	get maximum value for (vertical) y-axis of plot. More...
void	setXMin (double)
	set minimum value for x (horizontal) data. More...
void	setXMinPlot (double)
	set minimum value for (horizontal) x-axis of plot. More...
void	setXMinAuto (int)
	set flag indicating whether xMinPlot will be calculated automatically from the data. More...
void	setXMinNice (int)
	identical to method setXMinAuto(int). More...
void	setXMax (double)
	set maximum value for x (horizontal) data. More...
void	setXMaxPlot (double)
	set maximum value for (horizontal) x-axis of plot. More...
void	setXMaxAuto (int)
	set flag indicating whether xMaxPlot will be calculated automatically from the data. More...
void	setXMaxNice (int)
	identical to method setXMaxAuto(int). More...
void	setYMin (double)
	set minimum value for y (vertical) data. More...
void	setYMinPlot (double)
	set minimum value for (vertical) y-axis of plot. More...
void	setYMinAuto (int)
	set flag indicating whether yMinPlot will be calculated automatically from the data. More...
void	setYMinNice (int)
	identical to method setYMinAuto(int). More...
void	setYMax (double)
	set maximum value for y (vertical) data. More...
void	setYMaxPlot (double)
	set maximum value for (vertical) y-axis of plot. More...
void	setYMaxAuto (int)
	set flag indicating whether yMaxPlot will be calculated automatically from the data. More...
void	setYMaxNice (int)
	identical to method setYMaxAuto(int). More...
void	updateXMin (int)
	update xMinPlot using only the specified number of recently added data points. More...
void	updateXMax (int)
	update xMaxPlot using only the specified number of recently added data points. More...
void	updateYMin (int)
	update yMinPlot using only the specified number of recently added data points. More...
void	updateYMax (int)
	update yMaxPlot using only the specified number of recently added data points. More...
void	calcLims ()
	calculate the minima & maxima for the plot. More...
void	calcXMin ()
	calculate the minimum for the (horizontal) x-axis of the plot. More...
void	calcXMax ()
	calculate the maximum for the (horizontal) x-axis of the plot. More...
void	calcYMin ()
	calculate the minimum for the (vertical) y-axis of the plot. More...
void	calcYMax ()
	calculate the maximum for the (vertical) y-axis of the plot. More...
void	appendSeries (int, int)
	Append a new TxDataSeries object to the list, specifying integers for access to the horizontal and vertical data, respectively. More...
int	getNumSeries ()
	get the number of data series associated with this plot description. More...
int	getXIndex (int iseries)
	get the integer used to access the x (horizontal) data associated with the specified TxDataSeries object. More...
int	getYIndex (int iseries)
	get the integer used to access the y (vertical) data associated with the specified TxDataSeries object. More...
Private Attributes
TXSTD::string	xLabel
	label for the (horizontal) x-axis. More...
TXSTD::string	yLabel
	label for the (vertical) y-axis. More...
TXSTD::string	title
	title for the plot. More...
const TxLinePlotData*	txLinePlotData
	pointer to the TxLinePlotData object that holds the actual data to be plotted. More...
TXSTD::vector<TxDataSeries>	txDataSeries
	A list of TxDataSeries objects: a TxDataSeries object is instantiated for each actual data series stored in the TxLinePlotData object; these objects hold relevant plotting data, like minima, maxima, symbol for plotting, etc. More...
double	xMin
	Minimum value for the horizontal data used in this plot. More...
double	xMinPlot
	Minimum horizontal value for this plot. More...
int	xMinAuto
	flag indicating whether to automatically calculate xMinPlot or to use a specified value. More...
int	xMinNice
	not used. More...
double	xMax
	Maximum value for the horizontal data used in this plot. More...
double	xMaxPlot
	Maximum horizontal value for this plot. More...
int	xMaxAuto
	flag indicating whether to automatically calculate xMaxPlot or to use a specified value. More...
int	xMaxNice
	not used. More...
double	yMin
	Minimum value for the vertical data used in this plot. More...
double	yMinPlot
	Minimum vertical value for this plot. More...
int	yMinAuto
	flag indicating whether to automatically calculate yMinPlot or to use a specified value. More...
int	yMinNice
	not used. More...
double	yMax
	Maximum value for the vertical data used in this plot. More...
double	yMaxPlot
	Maximum vertical value for this plot. More...
int	yMaxAuto
	flag indicating whether to automatically calculate yMaxPlot or to use a specified value. More...
int	yMaxNice
	not used. More...
Friends
ostream&	operator<< (ostream &, const TxLinePlotDesc &)
	overload the output operator. More...

---

Detailed Description

-- Contains description of parameters required for a line plot.

This class is heavily used by TxLinePlotData objects.

Copyright 1996, 1997, 1998 by Tech-X Corporation

Author:

John R. Cary

Version:

Id:

TxLinePlotDesc.h,v 1.1 2001/09/21 21:35:29 kgl Exp

Definition at line 37 of file TxLinePlotDesc.h.

---

Constructor & Destructor Documentation

TxLinePlotDesc::TxLinePlotDesc ( )

default constructor.

TxLinePlotDesc::TxLinePlotDesc ( const TxLinePlotData * )

typical constructor; includes pointer to class holding the plot data.

TxLinePlotDesc::TxLinePlotDesc ( const TxLinePlotData *, const TXSTD::string &, const TXSTD::string &, const TXSTD::string &, int, int )

constructor specifying pointer to class holding the plot data, plus (in order) the x label, the y label, the plot title, an integer to access the x (horizontal) data, and an integer to access the y (vertical) data.

TxLinePlotDesc::TxLinePlotDesc ( const TxLinePlotDesc & )

copy constructor.

TxLinePlotDesc::~TxLinePlotDesc ( ) [inline, virtual]

virtual destructor. Definition at line 58 of file TxLinePlotDesc.h.

---

Member Function Documentation

void TxLinePlotDesc::appendSeries ( int, int )

Append a new TxDataSeries object to the list, specifying integers for access to the horizontal and vertical data, respectively.

void TxLinePlotDesc::calcLims ( ) [inline]

calculate the minima & maxima for the plot. Definition at line 154 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::calcLims().

void TxLinePlotDesc::calcXMax ( )

calculate the maximum for the (horizontal) x-axis of the plot. Referenced by calcLims().

void TxLinePlotDesc::calcXMin ( )

calculate the minimum for the (horizontal) x-axis of the plot. Referenced by calcLims().

void TxLinePlotDesc::calcYMax ( )

calculate the maximum for the (vertical) y-axis of the plot. Referenced by calcLims().

void TxLinePlotDesc::calcYMin ( )

calculate the minimum for the (vertical) y-axis of the plot. Referenced by calcLims().

int TxLinePlotDesc::getNumSeries ( ) [inline]

get the number of data series associated with this plot description. Definition at line 179 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getNumSeries().

const TXSTD::string TxLinePlotDesc::getTitle ( ) const [inline]

get title of plot. Definition at line 61 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getTitle().

int TxLinePlotDesc::getXIndex ( int iseries ) [inline]

get the integer used to access the x (horizontal) data associated with the specified TxDataSeries object. Definition at line 185 of file TxLinePlotDesc.h.

const TXSTD::string TxLinePlotDesc::getXLabel ( ) const [inline]

get (horizontal) x label of plot. Definition at line 64 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getXLabel().

double TxLinePlotDesc::getXMax ( ) const [inline]

get maximum value for x (horizontal) data. Definition at line 73 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getXMax().

double TxLinePlotDesc::getXMaxPlot ( ) const [inline]

get maximum value for (horizontal) x-axis of plot. Definition at line 85 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getXMaxPlot().

double TxLinePlotDesc::getXMin ( ) const [inline]

get minimum value for x (horizontal) data. Definition at line 70 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getXMin().

double TxLinePlotDesc::getXMinPlot ( ) const [inline]

get minimum value for (horizontal) x-axis of plot. Definition at line 82 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getXMinPlot().

int TxLinePlotDesc::getYIndex ( int iseries ) [inline]

get the integer used to access the y (vertical) data associated with the specified TxDataSeries object. Definition at line 191 of file TxLinePlotDesc.h.

const TXSTD::string TxLinePlotDesc::getYLabel ( ) const [inline]

get (vertical) y label of plot. Definition at line 67 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getYLabel().

double TxLinePlotDesc::getYMax ( ) const [inline]

get maximum value for y (vertical) data. Definition at line 79 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getYMax().

double TxLinePlotDesc::getYMaxPlot ( ) const [inline]

get maximum value for (vertical) y-axis of plot. Definition at line 91 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getYMaxPlot().

double TxLinePlotDesc::getYMin ( ) const [inline]

get minimum value for y (vertical) data. Definition at line 76 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getYMin().

double TxLinePlotDesc::getYMinPlot ( ) const [inline]

get minimum value for (vertical) y-axis of plot. Definition at line 88 of file TxLinePlotDesc.h. Referenced by TxLinePlotData::getYMinPlot().

const TxLinePlotDesc & TxLinePlotDesc::operator= ( const TxLinePlotDesc & )

assignment operator.

void TxLinePlotDesc::setXMax ( double )

set maximum value for x (horizontal) data. Referenced by TxLinePlotData::setXMax().

void TxLinePlotDesc::setXMaxAuto ( int )

set flag indicating whether xMaxPlot will be calculated automatically from the data. Referenced by TxLinePlotData::setXMaxAuto().

void TxLinePlotDesc::setXMaxNice ( int )

identical to method setXMaxAuto(int). Referenced by TxLinePlotData::setXMaxNice().

void TxLinePlotDesc::setXMaxPlot ( double )

set maximum value for (horizontal) x-axis of plot. Referenced by TxLinePlotData::setXMaxPlot().

void TxLinePlotDesc::setXMin ( double )

set minimum value for x (horizontal) data. Referenced by TxLinePlotData::setXMin().

void TxLinePlotDesc::setXMinAuto ( int )

set flag indicating whether xMinPlot will be calculated automatically from the data. Referenced by TxLinePlotData::setXMinAuto().

void TxLinePlotDesc::setXMinNice ( int )

identical to method setXMinAuto(int). Referenced by TxLinePlotData::setXMinNice().

void TxLinePlotDesc::setXMinPlot ( double )

set minimum value for (horizontal) x-axis of plot. Referenced by TxLinePlotData::setXMinPlot().

void TxLinePlotDesc::setYMax ( double )

set maximum value for y (vertical) data. Referenced by TxLinePlotData::setYMax().

void TxLinePlotDesc::setYMaxAuto ( int )

set flag indicating whether yMaxPlot will be calculated automatically from the data. Referenced by TxLinePlotData::setYMaxAuto().

void TxLinePlotDesc::setYMaxNice ( int )

identical to method setYMaxAuto(int). Referenced by TxLinePlotData::setYMaxNice().

void TxLinePlotDesc::setYMaxPlot ( double )

set maximum value for (vertical) y-axis of plot. Referenced by TxLinePlotData::setYMaxPlot().

void TxLinePlotDesc::setYMin ( double )

set minimum value for y (vertical) data. Referenced by TxLinePlotData::setYMin().

void TxLinePlotDesc::setYMinAuto ( int )

set flag indicating whether yMinPlot will be calculated automatically from the data. Referenced by TxLinePlotData::setYMinAuto().

void TxLinePlotDesc::setYMinNice ( int )

identical to method setYMinAuto(int). Referenced by TxLinePlotData::setYMinNice().

void TxLinePlotDesc::setYMinPlot ( double )

set minimum value for (vertical) y-axis of plot. Referenced by TxLinePlotData::setYMinPlot().

void TxLinePlotDesc::updateXMax ( int )

update xMaxPlot using only the specified number of recently added data points.

void TxLinePlotDesc::updateXMin ( int )

update xMinPlot using only the specified number of recently added data points.

void TxLinePlotDesc::updateYMax ( int )

update yMaxPlot using only the specified number of recently added data points.

void TxLinePlotDesc::updateYMin ( int )

update yMinPlot using only the specified number of recently added data points.

---

Friends And Related Function Documentation

ostream & operator<< ( ostream &, const TxLinePlotDesc & ) [friend]

overload the output operator.

---

Member Data Documentation

TXSTD::string TxLinePlotDesc::title [private]

title for the plot. Definition at line 203 of file TxLinePlotDesc.h.

TXSTD::vector< TxDataSeries > TxLinePlotDesc::txDataSeries [private]

A list of TxDataSeries objects: a TxDataSeries object is instantiated for each actual data series stored in the TxLinePlotData object; these objects hold relevant plotting data, like minima, maxima, symbol for plotting, etc. Definition at line 212 of file TxLinePlotDesc.h.

const TxLinePlotData * TxLinePlotDesc::txLinePlotData [private]

pointer to the TxLinePlotData object that holds the actual data to be plotted. Definition at line 206 of file TxLinePlotDesc.h.

TXSTD::string TxLinePlotDesc::xLabel [private]

label for the (horizontal) x-axis. Definition at line 199 of file TxLinePlotDesc.h.

double TxLinePlotDesc::xMax [private]

Maximum value for the horizontal data used in this plot. Definition at line 224 of file TxLinePlotDesc.h.

int TxLinePlotDesc::xMaxAuto [private]

flag indicating whether to automatically calculate xMaxPlot or to use a specified value. Definition at line 228 of file TxLinePlotDesc.h.

int TxLinePlotDesc::xMaxNice [private]

not used. Definition at line 230 of file TxLinePlotDesc.h.

double TxLinePlotDesc::xMaxPlot [mutable, private]

Maximum horizontal value for this plot. Definition at line 226 of file TxLinePlotDesc.h.

double TxLinePlotDesc::xMin [private]

Minimum value for the horizontal data used in this plot. Definition at line 215 of file TxLinePlotDesc.h.

int TxLinePlotDesc::xMinAuto [private]

flag indicating whether to automatically calculate xMinPlot or to use a specified value. Definition at line 219 of file TxLinePlotDesc.h.

int TxLinePlotDesc::xMinNice [private]

not used. Definition at line 221 of file TxLinePlotDesc.h.

double TxLinePlotDesc::xMinPlot [mutable, private]

Minimum horizontal value for this plot. Definition at line 217 of file TxLinePlotDesc.h.

TXSTD::string TxLinePlotDesc::yLabel [private]

label for the (vertical) y-axis. Definition at line 201 of file TxLinePlotDesc.h.

double TxLinePlotDesc::yMax [private]

Maximum value for the vertical data used in this plot. Definition at line 242 of file TxLinePlotDesc.h.

int TxLinePlotDesc::yMaxAuto [private]

flag indicating whether to automatically calculate yMaxPlot or to use a specified value. Definition at line 246 of file TxLinePlotDesc.h.

int TxLinePlotDesc::yMaxNice [private]

not used. Definition at line 248 of file TxLinePlotDesc.h.

double TxLinePlotDesc::yMaxPlot [private]

Maximum vertical value for this plot. Definition at line 244 of file TxLinePlotDesc.h.

double TxLinePlotDesc::yMin [private]

Minimum value for the vertical data used in this plot. Definition at line 233 of file TxLinePlotDesc.h.

int TxLinePlotDesc::yMinAuto [private]

flag indicating whether to automatically calculate yMinPlot or to use a specified value. Definition at line 237 of file TxLinePlotDesc.h.

int TxLinePlotDesc::yMinNice [private]

not used. Definition at line 239 of file TxLinePlotDesc.h.

double TxLinePlotDesc::yMinPlot [private]

Minimum vertical value for this plot. Definition at line 235 of file TxLinePlotDesc.h.

---

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

• TxLinePlotDesc.h

Copyright Tech-X Corporation, all rights reserved.