In file PlotSet/DataDesc.hh:

class AttDataDescriptor

Attribute for making data objects 'plot aware'

Inheritance:

Public Methods

AttDataDescriptor ()
Default constructor.
virtual ~AttDataDescriptor ()
Destructor.
AttDataDescriptor (const AttDataDescriptor& att)
Copy constructor.
AttDataDescriptor& operator= (const AttDataDescriptor& att)
Assignment operator.
virtual BasicDataDescriptor* NewDataDescriptor () const
New data descriptor method.
virtual const char* GetGraphType () const
Get graph type method.
virtual const char* GetAChannel () const
Get A channel method.
virtual const char* GetBChannel () const
Get B channel method.
const BasicPlotDescriptor* GetParentPlotDescriptor () const
Get parent plot descriptor.
virtual void UpdatePlot () const
Update plot method.

Documentation

When inheriting from this data descriptor attribute object and overwritting the 'NewDataDescriptor' method a user data object can be made 'plot aware'. This means that this object can then be used by plotting routines directly. To make it work the 'NewDataDescriptor' method must return a valid data descriptor pointing to the data stored by the user object. 'Self aware' user object can also override the 'GetGraphType', the 'GetAChannel' and optionally the 'GetBChannel' to provide the plotting routines with graph type and channel names. If not, they have to be specified when invoking the plotting routine. This object will add some overhead to the user data object (copy contructor, assignment operator, virtual methods, virtual destructor). The attribute also provides the method 'UpdatePlot' which can be used by the user object after its data has been changed to update the plots.

Current limitations: Can only be used by one plot set at a time.

AttDataDescriptor()
Constructs a data descriptor attribute.
Returns:
void

virtual ~AttDataDescriptor()
Destructs the data descriptor attribute.
Returns:
void

AttDataDescriptor(const AttDataDescriptor& att)
Constructs a data descriptor attribute from another one.
Returns:
void
Parameters:
att - Data descriptor attribute

AttDataDescriptor& operator= (const AttDataDescriptor& att)
Assigns data descriptor attributes.
Returns:
*this
Parameters:
att - Data descriptor attribute

virtual BasicDataDescriptor* NewDataDescriptor() const
Returns a data descriptor for the user data object. This method MUST be overwritten by derived classes.
Returns:
Data descriptor

virtual const char* GetGraphType() const
Returns the graph type of the user data object. This method might be overwritten by derived classes.
Returns:
Graph type string

virtual const char* GetAChannel() const
Returns the name of the A channel of the user data object. This method might be overwritten by derived classes.
Returns:
A channel string

virtual const char* GetBChannel() const
Returns the name of the B channel of the user data object. This method might be overwritten by derived classes.
Returns:
B channel string

const BasicPlotDescriptor* GetParentPlotDescriptor() const
Returns the plot descriptor which owns the data descriptor.
Returns:
Parent plot descriptor

virtual void UpdatePlot() const
Updates all plots which are using the data of the user object decribed by this data descriptor attribute. plot descriptor.
Returns:
void

This class has no child classes.
Author:
Written November 1999 by Daniel Sigg
Version:
1.0

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++