TotalTextRep Class Reference

#include <TotalTextRep.h>

Inheritance diagram for TotalTextRep:

[legend]Collaboration diagram for TotalTextRep:

[legend]List of all members.

Detailed Description

A TextRepBase class that draws projected values as a total.

Author:: Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 23 of file TotalTextRep.h.

Public Member Functions

virtual RepBase * clone ()

Returns a copy of the object.

virtual const Color & color () const

Returns the representation's color.

virtual void displayError (ViewBase &view)

Display an error message.

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

As a convience for implementors of derived classes of this class, the implementation here does nothing but satisfy the pure virtual function in the base class.

virtual void drawProjectedValues (ProjectorBase &projector, ViewBase &view)

Draws the values from the projector to the view.

virtual const Color & getColor () const

Get the color of the representation.

virtual unsigned int getStyle () const

Returns the style of the point representation.

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

Sets the color of the representation.

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

Sets the error representation on specified axis, if any, to yes.

virtual void setHighLighted (bool yes)

Sets the highlighted state of the point representation.

virtual void setSelected (bool yes=true)

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

void setSize (float value)

Sets the size of the representation.

virtual void setStyle (unsigned int style)

Sets the symbol of the representation.

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.

TotalTextRep (const TotalTextRep &point_rep)

The copy constructor.

TotalTextRep ()

The default constructor.

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.

Protected Attributes

Color m_color

The color of the representation.

bool m_desel

A flag to indicate the representation is de-selected.

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.

Constructor & Destructor Documentation

TotalTextRep::TotalTextRep ( )

The default constructor.

Definition at line 36 of file TotalTextRep.cxx.
Referenced by clone().

TotalTextRep::TotalTextRep ( const TotalTextRep & point_rep )

The copy constructor.

Definition at line 41 of file TotalTextRep.cxx.

Member Function Documentation

RepBase * TotalTextRep::clone ( ) [virtual]

Returns a copy of the object.

Implements TextRepBase.
Definition at line 47 of file TotalTextRep.cxx.
References TotalTextRep().

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(), ColumnPointRep::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 TextRepBase::drawProjectedValues ( const DataSource * ntuple,

TransformBase * transform,

ViewBase * view

) [virtual, inherited]

As a convience for implementors of derived classes of this class, the implementation here does nothing but satisfy the pure virtual function in the base class.

See also:
RepBase::drawProjectedValues for details of what might be done.

Implements RepBase.
Definition at line 26 of file TextRepBase.cxx.

void TotalTextRep::drawProjectedValues ( ProjectorBase & projector,

ViewBase & view

) [virtual]

Draws the values from the projector to the view.

Implements TextRepBase.
Definition at line 54 of file TotalTextRep.cxx.
References ViewBase::drawText(), ProjectorBase::getNumberOfEntries(), and RepBase::m_size.

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 RepBase::getStyle ( ) const [virtual, inherited]

Returns the style of the point representation.
Derived class should override this member function if they support styles. This base class implementation returns 0.
Reimplemented in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 108 of file RepBase.cxx.
Referenced by PointRepXML::setAttributes().

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 RepBase::setColor ( const Color & ) [virtual, inherited]

Sets the color of the representation.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 51 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createObject(), CutRangeRep::CutRangeRep(), FunctionRep::FunctionRep(), LineDataRep::LineDataRep(), SymbolPointRep::setColor(), ColumnPointRep::setColor(), and DataRep::setRepColor().

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

bool yes = true

) [virtual, inherited]

Sets the error representation on specified axis, if any, to yes.

Todo:
This member Needs to be implemented in some derived classes.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 128 of file RepBase.cxx.
Referenced by PointRepXML::createObject(), and DataRep::setErrorDisplay().

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 RepBase::setSelected ( bool yes = true ) [virtual, inherited]

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

Reimplemented in PointRepBase.
Definition at line 70 of file RepBase.cxx.
References RepBase::m_desel.
Referenced by PointRepBase::setSelected(), and DataRep::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 RepBase::setStyle ( unsigned int style ) [virtual, inherited]

Sets the symbol of the representation.
Derived classes may use this method to set the style of the representation, if they have various styles. This base class implementation does nothing.
Reimplemented in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 101 of file RepBase.cxx.
Referenced by DataRep::setRepStyle().

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(), ColumnPointRep::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 RepBase::yError ( ) const [virtual, inherited]

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

Member Data Documentation

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

bool RepBase::m_highlite [protected, inherited]

Sets the state of highlighting.

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

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

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 ()
	Returns a copy of the object.
virtual const Color &	color () const
	Returns the representation's color.
virtual void	displayError (ViewBase &view)
	Display an error message.
virtual void	drawProjectedValues (const DataSource ntuple, TransformBase transform, ViewBase *view)
	As a convience for implementors of derived classes of this class, the implementation here does nothing but satisfy the pure virtual function in the base class.
virtual void	drawProjectedValues (ProjectorBase &projector, ViewBase &view)
	Draws the values from the projector to the view.
virtual const Color &	getColor () const
	Get the color of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the point representation.
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 &)
	Sets the color of the representation.
virtual void	setErrorOn (const std::string &axis, bool yes=true)
	Sets the error representation on specified axis, if any, to yes.
virtual void	setHighLighted (bool yes)
	Sets the highlighted state of the point representation.
virtual void	setSelected (bool yes=true)
	Sets the representation to be selected if yes is `true`, otherwise set it to be deselected.
void	setSize (float value)
	Sets the size of the representation.
virtual void	setStyle (unsigned int style)
	Sets the symbol of the representation.
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.
	TotalTextRep (const TotalTextRep &point_rep)
	The copy constructor.
	TotalTextRep ()
	The default constructor.
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.
Protected Attributes
Color	m_color
	The color of the representation.
bool	m_desel
	A flag to indicate the representation is de-selected.
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.