ColumnPointRep Class Reference

#include <ColumnPointRep.h>

Inheritance diagram for ColumnPointRep:

[legend]Collaboration diagram for ColumnPointRep:

[legend]List of all members.

Detailed Description

A PointRep class that draws a column to represent the value.

The following plot was made using ColumnPointRep.

Requests:: Needs version which draws histogram on its side.

Plot with ColumnPointRep

Author:: Oded Wurman <owurman@stanford.edu>

Definition at line 31 of file ColumnPointRep.h.

Public Member Functions

virtual RepBase * clone ()

The clone function returns an object of its own kind which is a copy of this object at this moment.

virtual const Color & color () const

Returns the representation's color.

ColumnPointRep (const ColumnPointRep &point_rep)

The copy constructor.

ColumnPointRep ()

The default constructor.

virtual void displayError (ViewBase &view)

Display an error message.

virtual void drawProjectedValues (const DataSource *ntuple, TransformBase *transform, ViewBase *view)

Draws the projected values.

virtual const Color & getColor () const

Get the color of the representation.

virtual unsigned int getStyle () const

Returns the style of the line drawing.

virtual const BinToColor * getValueTransform () const

Returns the value transform.

virtual bool isSelected () const

Returns true if representation is in selected state, otherwise returns false.

const std::string & name () const

Returns the name of the representation.

virtual void setColor (const Color &color)

Sets the Color.

virtual void setErrorOn (const std::string &axis, bool yes=true)

Sets the error display on or off.

virtual void setHighLighted (bool yes)

Sets the highlighted state of the point representation.

virtual void setSelected (bool yes)

Sets the selection state of the representation.

void setSize (float value)

Sets the size of the representation.

virtual void setStyle (unsigned int style)

Sets the style of the line drawing.

void setText (const std::string &text)

Sets the text.

virtual void setValueTransform (BinToColor *)

Sets the value transform.

float size () const

Returns the size of the representation.

virtual bool xError () const

Returns true if the point representation displays error on the X axis.

virtual bool yError () const

Returns true if the point representation displays error on the Y axis.

~ColumnPointRep ()

The destructor.

Protected Attributes

Color m_color

The color of the representation.

bool m_desel

A flag to indicate the representation is de-selected.

ErrorBarRep * m_error_rep

The error bar representation.

bool m_highlite

Sets the state of highlighting.

std::string m_name

The name of the representation.

float m_size

The size of the representation.

std::string m_text

The text to be displayed before the statistics.

Static Protected Attributes

static const Color s_desel_color

The color of the representation when it is de-selected.

Private Attributes

bool m_clear_flag

A flag that the cache has been cleared.

hippodraw::Line::Style m_line_style

The style currently used.

std::vector< double > m_x

A cache of the points to be drawn along the X axis.

std::vector< double > m_y

A cache of the points to be drawn along the Y axis.

bool m_y_flag

The Y error flag.

Constructor & Destructor Documentation

ColumnPointRep::ColumnPointRep ( )

The default constructor.

Todo:
Could postpone creation of the ErrorBarRep until flag is set to require one.
However, if postponed, got to remember to set the color.
Definition at line 39 of file ColumnPointRep.cxx.
References PointRepBase::m_error_rep.
Referenced by clone().

ColumnPointRep::ColumnPointRep ( const ColumnPointRep & point_rep )

The copy constructor.

Definition at line 47 of file ColumnPointRep.cxx.
References ErrorBarRep::clone(), clone(), and PointRepBase::m_error_rep.

ColumnPointRep::~ColumnPointRep ( )

The destructor.

Definition at line 56 of file ColumnPointRep.cxx.
References PointRepBase::m_error_rep.

Member Function Documentation

RepBase * ColumnPointRep::clone ( ) [virtual]

The clone function returns an object of its own kind which is a copy of this object at this moment.

Implements PointRepBase.
Definition at line 61 of file ColumnPointRep.cxx.
References ColumnPointRep().
Referenced by ColumnPointRep().

const Color & RepBase::color ( ) const [virtual, inherited]

Returns the representation's color.

Todo:
Remove this member in favor of getColor().

Definition at line 61 of file RepBase.cxx.
References RepBase::m_color, RepBase::m_desel, and RepBase::s_desel_color.
Referenced by ContourPointRep::createContours(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), ErrorBarRep::drawProjectedValues(), drawProjectedValues(), ColorSymbolPointRep::drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), and DataRep::getRepColor().

void RepBase::displayError ( ViewBase & view ) [virtual, inherited]

Display an error message.
Display an error message instead of drawing a point. This base class implementation displays a message with the name of the RepBase object.
Definition at line 153 of file RepBase.cxx.
References ViewBase::drawText(), RepBase::m_name, and RepBase::m_size.

void ColumnPointRep::drawProjectedValues ( const DataSource * ntuple,

TransformBase * transform,

ViewBase * view

) [virtual]

Draws the projected values.
Draws the projected values contained in the DataSource ntuple. Each row of the ntuple is data point tuple of some dimension. Derived classes expect the DataSoruce to be of the correct dimension. The drawn points undergo a transform represented by transform and are drawn to the view view. If highlighting is on, uses the ranges to control highlighting.
Implements RepBase.
Definition at line 116 of file ColumnPointRep.cxx.
References RepBase::color(), PointRepBase::m_error_rep, m_line_style, RepBase::m_size, m_x, m_y, m_y_flag, HippoRectangle::makeInBounds(), RepBase::size(), hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, and hippodraw::Axes::Y.

const Color & RepBase::getColor ( ) const [virtual, inherited]

Get the color of the representation.

Definition at line 56 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createElement().

unsigned int ColumnPointRep::getStyle ( ) const [virtual]

Returns the style of the line drawing.

Reimplemented from RepBase.
Definition at line 85 of file ColumnPointRep.cxx.
References m_line_style.

const BinToColor * RepBase::getValueTransform ( ) const [virtual, inherited]

Returns the value transform.
A value transform changes a binary value to some graphical representations such as color. The implementation in this base class returns a null pointer. Derived classes that implement value transform should return a pointer to the object it uses.
Reimplemented in ColorBoxPointRep, ColorSymbolPointRep, and ContourPointRep.
Definition at line 139 of file RepBase.cxx.
Referenced by PointRepXML::createElement().

bool RepBase::isSelected ( ) const [virtual, inherited]

Returns true if representation is in selected state, otherwise returns false.

Definition at line 77 of file RepBase.cxx.
References RepBase::m_desel.
Referenced by DataRep::isSelected().

const string & RepBase::name ( ) const [inherited]

Returns the name of the representation.
This name might be used by a Factory.
Definition at line 45 of file RepBase.cxx.
References RepBase::m_name.
Referenced by FuncParmRep::drawProjectedValues(), PointRepXML::setAttributes(), QtDisplay::setContourLevels(), and Inspector::updatePlotTab().

void ColumnPointRep::setColor ( const Color & color ) [virtual]

Sets the Color.
Sets the Color of both the representation and its ErrorBarRep if any.
Reimplemented from RepBase.
Definition at line 67 of file ColumnPointRep.cxx.
References PointRepBase::m_error_rep, and RepBase::setColor().

void ColumnPointRep::setErrorOn ( const std::string & axis,

bool yes = true

) [virtual]

Sets the error display on or off.
Sets the error display on the Y axis if axis is the Y axis, otherwise does nothing.
Reimplemented from RepBase.
Definition at line 92 of file ColumnPointRep.cxx.
References PointRepBase::m_error_rep, m_y_flag, and ErrorBarRep::setYError().

void RepBase::setHighLighted ( bool yes ) [virtual, inherited]

Sets the highlighted state of the point representation.
If yes is true, then the point representation should show the non highlighted regions in some fashion, typically using light gray color instead of its normal color.
See also:
setSelected (bool)
m_ranges.

Definition at line 84 of file RepBase.cxx.
References RepBase::m_highlite.

void PointRepBase::setSelected ( bool yes ) [virtual, inherited]

Sets the selection state of the representation.
Also sets the selection state of the ErrorBarRep representation, if any. If yes is false, the point representation should shows its deselected stated by some fashion, typically using a light gray color instead of its normal color.
Reimplemented from RepBase.
Definition at line 36 of file PointRepBase.cxx.
References PointRepBase::m_error_rep, and RepBase::setSelected().

void RepBase::setSize ( float value ) [inherited]

Sets the size of the representation.

Definition at line 94 of file RepBase.cxx.
References RepBase::m_size.
Referenced by PointRepXML::createObject(), FunctionRep::FunctionRep(), and DataRep::setRepSize().

void ColumnPointRep::setStyle ( unsigned int style ) [virtual]

Sets the style of the line drawing.

Reimplemented from RepBase.
Definition at line 78 of file ColumnPointRep.cxx.
References hippodraw::Axes::convert(), and m_line_style.

void RepBase::setText ( const std::string & text ) [inherited]

Sets the text.

Definition at line 132 of file RepBase.cxx.
References RepBase::m_text.
Referenced by DisplayController::createTextDataRep().

void RepBase::setValueTransform ( BinToColor * ) [virtual, inherited]

Sets the value transform.
The implementation in this base class does nothing. Derived classes that implement a value transform should override this method and take possession of the received object.

Todo:
Should have base class that doesn't know about color and BinToColor class should derive from it.

Reimplemented in ColorBoxPointRep, ColorSymbolPointRep, and ContourPointRep.
Definition at line 146 of file RepBase.cxx.

float RepBase::size ( ) const [inherited]

Returns the size of the representation.

Definition at line 89 of file RepBase.cxx.
References RepBase::m_size.
Referenced by ContourPointRep::createContours(), ContourPointRep::drawContourTicks(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), ErrorBarRep::drawProjectedValues(), ContourPointRep::drawProjectedValues(), drawProjectedValues(), ColorSymbolPointRep::drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), DisplayController::pointSize(), and PointRepXML::setAttributes().

bool RepBase::xError ( ) const [virtual, inherited]

Returns true if the point representation displays error on the X axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented in SymbolPointRep.
Definition at line 114 of file RepBase.cxx.
Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

bool ColumnPointRep::yError ( ) const [virtual]

Returns true if the point representation displays error on the Y axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented from RepBase.
Definition at line 100 of file ColumnPointRep.cxx.
References m_y_flag.

Member Data Documentation

bool ColumnPointRep::m_clear_flag [private]

A flag that the cache has been cleared.

Definition at line 52 of file ColumnPointRep.h.

Color RepBase::m_color [protected, inherited]

The color of the representation.

Definition at line 55 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), RepBase::getColor(), and RepBase::setColor().

bool RepBase::m_desel [protected, inherited]

A flag to indicate the representation is de-selected.

Definition at line 64 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), ColorBoxPointRep::drawProjectedValues(), RepBase::isSelected(), and RepBase::setSelected().

ErrorBarRep* PointRepBase::m_error_rep [protected, inherited]

The error bar representation.
Will be a null pointer if a derived class doesn't have one.
Definition at line 42 of file PointRepBase.h.
Referenced by ColumnPointRep(), SymbolPointRep::drawProjectedValues(), drawProjectedValues(), SymbolPointRep::setColor(), setColor(), SymbolPointRep::setErrorOn(), setErrorOn(), PointRepBase::setSelected(), SymbolPointRep::SymbolPointRep(), ~ColumnPointRep(), and SymbolPointRep::~SymbolPointRep().

bool RepBase::m_highlite [protected, inherited]

Sets the state of highlighting.

Definition at line 68 of file RepBase.h.
Referenced by RepBase::setHighLighted().

hippodraw::Line::Style ColumnPointRep::m_line_style [private]

The style currently used.

Definition at line 49 of file ColumnPointRep.h.
Referenced by drawProjectedValues(), getStyle(), and setStyle().

std::string RepBase::m_name [protected, inherited]

The name of the representation.

Definition at line 49 of file RepBase.h.
Referenced by AverageTextRep::AverageTextRep(), ColorSymbolPointRep::ColorSymbolPointRep(), RepBase::displayError(), ContourPointRep::init(), and RepBase::name().

std::string RepBase::m_text [protected, inherited]

The text to be displayed before the statistics.

Definition at line 52 of file RepBase.h.
Referenced by BoxTextRep::drawProjectedValues(), and RepBase::setText().

std::vector< double > ColumnPointRep::m_x [private]

A cache of the points to be drawn along the X axis.
For efficiency, all the points are given to the view at once.
Definition at line 36 of file ColumnPointRep.h.
Referenced by drawProjectedValues().

std::vector< double > ColumnPointRep::m_y [private]

A cache of the points to be drawn along the Y axis.
For efficiency, all the points are given to the view at once.
Definition at line 41 of file ColumnPointRep.h.
Referenced by drawProjectedValues().

bool ColumnPointRep::m_y_flag [private]

The Y error flag.
If set true, error bars will be generated along the Y axis.
Definition at line 45 of file ColumnPointRep.h.
Referenced by drawProjectedValues(), setErrorOn(), and yError().

const Color RepBase::s_desel_color [static, protected, inherited]

The color of the representation when it is de-selected.

Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), and CutRangeRep::drawNormalRange().

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

Generated for HippoDraw-1.14.8.5 by

1.4.3


Public Member Functions
virtual RepBase *	clone ()
	The clone function returns an object of its own kind which is a copy of this object at this moment.
virtual const Color &	color () const
	Returns the representation's color.
	ColumnPointRep (const ColumnPointRep &point_rep)
	The copy constructor.
	ColumnPointRep ()
	The default constructor.
virtual void	displayError (ViewBase &view)
	Display an error message.
virtual void	drawProjectedValues (const DataSource ntuple, TransformBase transform, ViewBase *view)
	Draws the projected values.
virtual const Color &	getColor () const
	Get the color of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the line drawing.
virtual const BinToColor *	getValueTransform () const
	Returns the value transform.
virtual bool	isSelected () const
	Returns `true` if representation is in selected state, otherwise returns `false`.
const std::string &	name () const
	Returns the name of the representation.
virtual void	setColor (const Color &color)
	Sets the Color.
virtual void	setErrorOn (const std::string &axis, bool yes=true)
	Sets the error display on or off.
virtual void	setHighLighted (bool yes)
	Sets the highlighted state of the point representation.
virtual void	setSelected (bool yes)
	Sets the selection state of the representation.
void	setSize (float value)
	Sets the size of the representation.
virtual void	setStyle (unsigned int style)
	Sets the style of the line drawing.
void	setText (const std::string &text)
	Sets the text.
virtual void	setValueTransform (BinToColor *)
	Sets the value transform.
float	size () const
	Returns the size of the representation.
virtual bool	xError () const
	Returns true if the point representation displays error on the X axis.
virtual bool	yError () const
	Returns true if the point representation displays error on the Y axis.
	~ColumnPointRep ()
	The destructor.
Protected Attributes
Color	m_color
	The color of the representation.
bool	m_desel
	A flag to indicate the representation is de-selected.
ErrorBarRep *	m_error_rep
	The error bar representation.
bool	m_highlite
	Sets the state of highlighting.
std::string	m_name
	The name of the representation.
float	m_size
	The size of the representation.
std::string	m_text
	The text to be displayed before the statistics.
Static Protected Attributes
static const Color	s_desel_color
	The color of the representation when it is de-selected.
Private Attributes
bool	m_clear_flag
	A flag that the cache has been cleared.
hippodraw::Line::Style	m_line_style
	The style currently used.
std::vector< double >	m_x
	A cache of the points to be drawn along the X axis.
std::vector< double >	m_y
	A cache of the points to be drawn along the Y axis.
bool	m_y_flag
	The Y error flag.