Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

DataRep Class Reference

Inheritance diagram for DataRep:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 20 of file DataRep.sip.

Public Member Functions

virtual ~DataRep ()
 The destructor.
virtual DataRepclone ()=0
 The clone function returns an object of its own kind which is a copy of this object.
const std::string & name () const
 Returns the name of the display.
virtual void update (const Observable *)
 Responds to update message from the data source.
virtual bool hasErrorDisplay () const
 Returns true if the data representation is capable of error display on the data values.
virtual bool hasNTupleBindings () const
 Returns true if the DataRep's projector can bind to ntuple.
virtual void setAxisBinding (const std::string &, const std::string &)
 Sets the axis binding.
virtual void setAxisBindings (const std::vector< std::string > &)
 Sets the axis bindings.
virtual void matrixTranspose (bool)
 Transposes the X and Y axis.
RepBasegetRepresentation () const
 Returns the representation used to draw the data points.
const ColorgetRepColor () const
 Returns the color used for the representation.
bool isDirty () const
 Return true if the data representation has changed is some way and it needs to be re-drawn.
virtual void setRepresentation (RepBase *)
 Sets the representation of the data points.
void setRepColor (const Color &)
 Sets the color of the data representation.
void setRepSize (float)
 Sets the size of the representation.
void setRepStyle (int)
 Sets the style type of the point representation.
virtual void setDirty (bool=true)
 Sets the dirty flag.
virtual bool needColorRep () const
 Determines if extra space is needed for a color rep.
virtual void setSelected (bool=true)
 Sets the data representation as selected.
virtual bool isSelected () const
 Returns true if data representation is in selected state.
virtual bool acceptFunction (int)
 Returns true if the DataRep accepts functions on number variables.
virtual bool hasZeroRows ()
 Returns true if this DataRep has zero rows in its NTuple.
virtual void addValues (const std::vector< double > &)
 Add the data values to the DataRep.
virtual const DataSourcegetProjectedValues ()
 Returns an ntuple representation of the projected data.
virtual NTuplegetNTupleAfterCuts () const
 Returns the full NTuple but with the current set of cuts applied.
virtual double getMean (const std::string &)
 Returns the mean.
virtual double getRMS (const std::string &)
 Returns the RMS.
virtual DataRepgetParentDataRep ()
 Gets the parent DataRep.
virtual void setParentDataRep (DataRep *)
 Sets the parent DataRep.
virtual void update ()
 Updates the data representation.
virtual void normalizeTo (const DataRep *)
 Normalizes the receiving object to the target one.
int getNumberOfEntries () const
 Returns the number of entries used for the DataRep object.
virtual bool isTargetable () const
 Returns true if the receiving object is target-able.

Protected Member Functions

 DataRep ()
 The default constructor.
 DataRep (const DataRep &)
 The copy constructor.


Constructor & Destructor Documentation

DataRep::DataRep  )  [protected]
 

The default constructor.

DataRep::DataRep const DataRep  )  [protected]
 

The copy constructor.

virtual DataRep::~DataRep  )  [virtual]
 

The destructor.


Member Function Documentation

virtual bool DataRep::acceptFunction int   )  [virtual]
 

Returns true if the DataRep accepts functions on number variables.

The default implementation returns false. Derived class should re-implement this member function if they accept functions of specified number of variables.

virtual void DataRep::addValues const std::vector< double > &   )  [virtual]
 

Add the data values to the DataRep.

This virtual method is provided as a convenience for those derived classes that respond to it. Nothing is done if this object has NTuple bindings. Otherwise the message is forward to its ProjectorBase object.

virtual DataRep* DataRep::clone  )  [pure virtual]
 

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

Implemented in LineDataRep.

virtual double DataRep::getMean const std::string &   )  [virtual]
 

Returns the mean.

Returns the mean data points along the axis axis.

virtual NTuple* DataRep::getNTupleAfterCuts  )  const [virtual]
 

Returns the full NTuple but with the current set of cuts applied.

int DataRep::getNumberOfEntries  )  const
 

Returns the number of entries used for the DataRep object.

virtual DataRep* DataRep::getParentDataRep  )  [virtual]
 

Gets the parent DataRep.

virtual const DataSource* DataRep::getProjectedValues  )  [virtual]
 

Returns an ntuple representation of the projected data.

const Color& DataRep::getRepColor  )  const
 

Returns the color used for the representation.

RepBase* DataRep::getRepresentation  )  const
 

Returns the representation used to draw the data points.

virtual double DataRep::getRMS const std::string &   )  [virtual]
 

Returns the RMS.

Returns the root mean square of the data points along the axis axis.

virtual bool DataRep::hasErrorDisplay  )  const [virtual]
 

Returns true if the data representation is capable of error display on the data values.

The implementation in this base class returns false. This member function should be overridden by derived classes capable of displaying errors on the data points.

virtual bool DataRep::hasNTupleBindings  )  const [virtual]
 

Returns true if the DataRep's projector can bind to ntuple.

The implementation in this base class is to return true.

Reimplemented in LineDataRep.

virtual bool DataRep::hasZeroRows  )  [virtual]
 

Returns true if this DataRep has zero rows in its NTuple.

Returns false if the projector is not an NTupleProjector.

bool DataRep::isDirty  )  const
 

Return true if the data representation has changed is some way and it needs to be re-drawn.

virtual bool DataRep::isSelected  )  const [virtual]
 

Returns true if data representation is in selected state.

See also:
setSelected

virtual bool DataRep::isTargetable  )  const [virtual]
 

Returns true if the receiving object is target-able.

Most derived classes of DataRep are target-able and return true. That is, they can be targets of cuts, functions, etc. If a derived class is not intended to be a target, it should return false. The implementation in this base class returns true.

virtual void DataRep::matrixTranspose bool   )  [virtual]
 

Transposes the X and Y axis.

If internal representation of the X-Y matrix is represented by a vector with shape, then transpose the X and Y axis. Otherwise do nothing.

Note:
The implementation passes the request to the contained projector.

const std::string& DataRep::name  )  const
 

Returns the name of the display.

See m_name.

virtual bool DataRep::needColorRep  )  const [virtual]
 

Determines if extra space is needed for a color rep.

virtual void DataRep::normalizeTo const DataRep  )  [virtual]
 

Normalizes the receiving object to the target one.

virtual void DataRep::setAxisBinding const std::string &  ,
const std::string & 
[virtual]
 

Sets the axis binding.

Sets binding of the axis with name axis to the NTuple column with label label. If the derived class does not have NTuple bindings, then does nothing. Derived classes may also do further processing upon reception of this method.

virtual void DataRep::setAxisBindings const std::vector< std::string > &   )  [virtual]
 

Sets the axis bindings.

Sets the binding of all axis to the NTuple column with the labels in the vector. If the derived class does not have NTuple bindings, then does nothing. Derived classes may also do further processing upon reception of this method.

virtual void DataRep::setDirty bool  = true  )  [virtual]
 

Sets the dirty flag.

When set, the display may need to reinitialize itself before the next drawing.

virtual void DataRep::setParentDataRep DataRep  )  [virtual]
 

Sets the parent DataRep.

void DataRep::setRepColor const Color  ) 
 

Sets the color of the data representation.

virtual void DataRep::setRepresentation RepBase  )  [virtual]
 

Sets the representation of the data points.

The pointrep replaces the existing one, and the existing one is then destroyed. Maybe be overridden in derive class to do additional processing.

void DataRep::setRepSize float   ) 
 

Sets the size of the representation.

void DataRep::setRepStyle int   ) 
 

Sets the style type of the point representation.

virtual void DataRep::setSelected bool  = true  )  [virtual]
 

Sets the data representation as selected.

Selection means the representations is drawn in its normal color, If representation is not selected, then it draws in a lighter shade.

virtual void DataRep::update  )  [virtual]
 

Updates the data representation.

Updates the data representation, however, derived classes are allowed to be lazy and not do the actual update until needed by drawProjectedValues.

virtual void DataRep::update const Observable  )  [virtual]
 

Responds to update message from the data source.


The documentation for this class was generated from the following file:
Generated on Wed Sep 7 14:51:47 2005 for SiHippo by  doxygen 1.4.3