CartesianPlot Class Reference
A two-dimensional Cartesian plot. More...
#include <CartesianPlot.h>
Public Member Functions | |
| virtual std::list < ContextMenuAction > | getContextMenuActions () const =0 |
| virtual CartesianGridlines * | getGridlines (OrientationType orientation)=0 |
| virtual const CartesianGridlines * | getGridlines (OrientationType orientation) const =0 |
| virtual void | setXScaleType (ScaleType scaleType)=0 |
| virtual void | setYScaleType (ScaleType scaleType)=0 |
| virtual ScaleType | getXScaleType () const =0 |
| virtual ScaleType | getYScaleType () const =0 |
| virtual void | setXDataType (const std::string &dataType)=0 |
| virtual void | setYDataType (const std::string &dataType)=0 |
| virtual std::string | getXDataType () const =0 |
| virtual std::string | getYDataType () const =0 |
Static Public Member Functions | |
| static const std::string & | signalXScaleTypeChanged () |
| static const std::string & | signalYScaleTypeChanged () |
| static const std::string & | signalXDataTypeChanged () |
| static const std::string & | signalYDataTypeChanged () |
Protected Member Functions | |
| virtual | ~CartesianPlot () |
Detailed Description
A two-dimensional Cartesian plot.A Cartesian plot can display either a linear scale or a log scale on either the x-axis, the y-axis, or both.
This subclass of Subject will notify upon the following conditions:
- The following methods are called: setXScaleType(), setYScaleType(), setXDataType(), setYDataType().
- Everything documented in PlotView.
- See also:
- PlotView
Definition at line 31 of file CartesianPlot.h.
Constructor & Destructor Documentation
| virtual CartesianPlot::~CartesianPlot | ( | ) | [protected, virtual] |
This object should be destroyed by calling DesktopServices::deleteView().
Definition at line 180 of file CartesianPlot.h.
Member Function Documentation
| static const std::string& CartesianPlot::signalXScaleTypeChanged | ( | ) | [static] |
Emitted with any<ScaleType> when the X scale type changes.
Definition at line 37 of file CartesianPlot.h.
| static const std::string& CartesianPlot::signalYScaleTypeChanged | ( | ) | [static] |
Emitted with any<ScaleType> when the Y scale type changes.
Definition at line 42 of file CartesianPlot.h.
| static const std::string& CartesianPlot::signalXDataTypeChanged | ( | ) | [static] |
Emitted with any<std::string> when the X data type changes.
Definition at line 47 of file CartesianPlot.h.
| static const std::string& CartesianPlot::signalYDataTypeChanged | ( | ) | [static] |
Emitted with any<std::string> when the Y data type changes.
Definition at line 52 of file CartesianPlot.h.
| virtual std::list<ContextMenuAction> CartesianPlot::getContextMenuActions | ( | ) | const [pure virtual] |
Returns the context menu actions available for this session item.
- Returns:
- The list of context menu actions that should be displayed when the user right-clicks on a widget displaying or containing the session item.
- See also:
- ContextMenuAction
- Default Implementation:
- The default implementation returns the context menu actions listed here. The default actions can be removed or additional actions can be added by attaching to the signalAboutToShowContextMenu() signal.
Implements SessionItem.
Implemented in HistogramPlot.
| virtual CartesianGridlines* CartesianPlot::getGridlines | ( | OrientationType | orientation | ) | [pure virtual] |
Returns a pointer to the plot's horizontal or vertical gridlines.
- Parameters:
-
orientation The orientation of the gridlines to get.
- Returns:
- A pointer to the plot's horizontal or vertical gridlines object.
| virtual const CartesianGridlines* CartesianPlot::getGridlines | ( | OrientationType | orientation | ) | const [pure virtual] |
Returns read-only access to the plot's horizontal or vertical gridlines.
- Parameters:
-
orientation The orientation of the gridlines to get.
- Returns:
- A const pointer to the plot's horizontal or vertical gridlines object. The plot object represented by the returned pointer should not be modified. To modify the values, call the non-const version of getGridlines(OrientationType).
| virtual void CartesianPlot::setXScaleType | ( | ScaleType | scaleType | ) | [pure virtual] |
Sets the scale type of the x-axis.
- Parameters:
-
scaleType The new x-axis scale type.
- Subject Notifications:
- This method notifies signalXScaleTypeChanged() if the given scale type is different than the current scale type.
| virtual void CartesianPlot::setYScaleType | ( | ScaleType | scaleType | ) | [pure virtual] |
Sets the scale type of the y-axis.
- Parameters:
-
scaleType The new y-axis scale type.
- Subject Notifications:
- This method notifies signalYScaleTypeChanged() if the given scale type is different than the current scale type.
| virtual ScaleType CartesianPlot::getXScaleType | ( | ) | const [pure virtual] |
Returns the scale type of the x-axis.
- Returns:
- The x-axis scale type.
| virtual ScaleType CartesianPlot::getYScaleType | ( | ) | const [pure virtual] |
Returns the scale type of the y-axis.
- Returns:
- The y-axis scale type.
| virtual void CartesianPlot::setXDataType | ( | const std::string & | dataType | ) | [pure virtual] |
Sets the data type of the x-axis.
The data type is an optional string that can be set to describe the data that is plotted along the x-axis. If the plot is contained in a PlotWidget, the data type is used as the axis text.
- Parameters:
-
dataType The x-axis data type. An empty string indicates that no data type is associated or known.
- Subject Notifications:
- This method notifies signalXDataTypeChanged() if the given data type is different than the current data type.
| virtual void CartesianPlot::setYDataType | ( | const std::string & | dataType | ) | [pure virtual] |
Sets the data type of the y-axis.
The data type is an optional string that can be set to describe the data that is plotted along the y-axis. If the plot is contained in a PlotWidget, the data type is used as the axis text.
- Parameters:
-
dataType The y-axis data type. An empty string indicates that no data type is associated or known.
- Subject Notifications:
- This method notifies signalYDataTypeChanged() if the given data type is different than the current data type.
| virtual std::string CartesianPlot::getXDataType | ( | ) | const [pure virtual] |
Returns the data type of the x-axis.
- Returns:
- The x-axis data type. An empty string indicates that no data type has been set.
- See also:
- setXDataType()
| virtual std::string CartesianPlot::getYDataType | ( | ) | const [pure virtual] |
Returns the data type of the y-axis.
- Returns:
- The y-axis data type. An empty string indicates that no data type has been set.
- See also:
- setYDataType()