ABSTRACT CLASSES //. More...
#include <PlotMSAction.h>
ABSTRACT CLASSES //.
Class that implements actions that operate on PlotMS. Actions get their type from the Type enum and their parameters (if needed) from mappings from Strings to values. Current parameter value types are: PlotMSPlot*, bool, String, int, and vector<PMS::Axis>.
Definition at line 47 of file PlotMSAction.h.
Static // Enum for implemented actions.
| SEL_FLAG |
Selection actions //. Flag the selected regions. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| SEL_UNFLAG |
Unflag the selected regions. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| SEL_LOCATE |
Locate on the selected regions. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| SEL_INFO |
Get metadata of points in the selected regions. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| SEL_CLEAR_REGIONS |
Clear the selected regions. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| ITER_FIRST |
Iteration actions //. Go to the first page of iteration. No required parameters. NOT IMPLEMENTED. |
| ITER_PREV |
Go to the previous page of iteration. No required parameters. NOT IMPLEMENTED. |
| ITER_NEXT |
Go to the next page of iteration. No required parameters. NOT IMPLEMENTED. |
| ITER_LAST |
Go to the last page of iteration. No required parameters. NOT IMPLEMENTED. |
| TOOL_MARK_REGIONS |
Tool actions //. Turns on/off the mark regions tool. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Only one of the mark regions, zoom, pan, and annotate tools can be turned on at one time. Required parameters: P_ON_OFF. |
| TOOL_SUBTRACT_REGIONS |
Turns on/off the subtract regions tool. works like MARK REGIONS, but where user drags, all regions within are deleted. (note: CAS-1971 DSW) |
| TOOL_ZOOM |
Turns on/off the zoom tool. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Only one of the mark regions, zoom, pan, and annotate tools can be turned on at one time. Required parameters: P_ON_OFF. |
| TOOL_PAN |
Turns on/off the pan tool. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Only one of the mark regions, zoom, pan, and annotate tools can be turned on at one time. Required parameters: P_ON_OFF. |
| TOOL_ANNOTATE_TEXT |
Turns on/off the annotator tool's different modes. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Only one of the mark regions, zoom, pan, and annotate tools can be turned on at one time. Required parameters: P_ON_OFF. |
| TOOL_ANNOTATE_RECTANGLE | |
| TRACKER_ENABLE_HOVER |
Turns on/off the tracker tool hover function. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Required parameters: P_ON_OFF. |
| TRACKER_ENABLE_DISPLAY |
Turns on/off the tracker tool display function. Operates on all canvases of all plots AT THE TIME of the call to doAction(). Required parameters: P_ON_OFF. |
| STACK_BACK |
Stack actions //. Goes back in the zoom/pan stack. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| STACK_BASE |
Goes to the base of the zoom/pan stack. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| STACK_FORWARD |
Goes forward in the zoom/pan stack. Operates on all visible canvases AT THE TIME of the call to doAction(). No required parameters. |
| CACHE_LOAD |
Cache actions //. Loads axes into the cache. Operates on a single PlotMSPlot. Required parameters: P_PLOT, P_AXES. |
| CACHE_RELEASE |
Releases axes from the cache. Operates on a single PlotMSPlot. Required parameters: P_PLOT, P_AXES. NOT IMPLEMENTED. |
| MS_SUMMARY |
Plot actions //. Display MS summary info for a specific file. Required parameters: P_PLOT. |
| SUMMARY_DIALOG |
Show the summary dialog for the plot that allows the user to set up parameters for MS_SUMMARY. |
| PLOT |
Updates any set parameters, which updates the plots. No required parameters. |
| PLOT_EXPORT |
Exports a single PlotMSPlot to a file. If format isn't given, it is set using the file name. If DPI, width, or height aren't set or are < 0, the default is used. Required parameters: P_PLOT, P_FILE. Optional parameters: P_FORMAT, P_HIGHRES, P_DPI, P_WIDTH, P_HEIGHT. |
| EXPORT_DIALOG |
Show a dialog that allows the client to set up export parameters. |
| HOLD_RELEASE_DRAWING |
Plotter actions //. Holds/releases drawing for all canvases in the PlotMSPlotter. Required parameters: P_ON_OFF. |
| CLEAR_PLOTTER |
Clears all plots and canvases from the PlotMSPlotter. No required parameters. |
| QUIT |
Quits PlotMS. No required parameters. |
| OPEN |
Open an ms or cal table for plotting. |
Definition at line 51 of file PlotMSAction.h.
| casa::PlotMSAction::PlotMSAction | ( | Client * | client, | |
| PMSPTMethod | postThreadMethod = NULL, |
|||
| vector< PlotMSPlot * > | postThreadObject = vector< PlotMSPlot * >() | |||
| ) |
Non-Static //.
Constructor.
| virtual casa::PlotMSAction::~PlotMSAction | ( | ) | [virtual] |
Destructor.
| casa::PlotMSAction::PlotMSAction | ( | const PlotMSAction & | other | ) | [private] |
| bool casa::PlotMSAction::doAction | ( | PlotMSApp * | plotms | ) |
Performs the action, using the given PlotMSApp, and returns true for success or false or failure.
| const String& casa::PlotMSAction::doActionResult | ( | ) | const |
Returns the result of doAction(), if applicable.
Usually this is used to return the error/reason why the action failed.
| virtual bool casa::PlotMSAction::doActionSpecific | ( | PlotMSApp * | plotms | ) | [protected, pure virtual] |
Implemented in casa::ActionCache, casa::ActionClearPlotter, casa::ActionClearRegions, casa::ActionExport, casa::ActionExportDialog, casa::ActionHoldReleaseDrawing, casa::ActionInformation, casa::ActionIterFirst, casa::ActionIterLast, casa::ActionIterNext, casa::ActionIterPrev, casa::ActionPlot, casa::ActionQuit, casa::ActionSelect, casa::ActionStack, casa::ActionSummary, casa::ActionSummaryDialog, casa::ActionTool, and casa::ActionTracker.
| virtual bool casa::PlotMSAction::doActionWithResponse | ( | PlotMSApp * | plotms, | |
| Record & | retval | |||
| ) | [virtual] |
Reimplemented in casa::ActionInformation.
| bool casa::PlotMSAction::initiateWork | ( | BackgroundThread * | thread | ) | [protected] |
| bool casa::PlotMSAction::isValid | ( | ) | [private] |
Returns true if the action is valid or not.
Invalid actions should not be executed.
| virtual bool casa::PlotMSAction::loadParameters | ( | ) | [protected, virtual] |
Reimplemented in casa::ActionCache, casa::ActionExport, casa::ActionHoldReleaseDrawing, casa::ActionSummary, casa::ActionTool, and casa::ActionTracker.
| void casa::PlotMSAction::setUpClientCommunication | ( | BackgroundThread * | thread, | |
| int | index | |||
| ) | [protected] |
| void casa::PlotMSAction::setUseThreading | ( | bool | useThread | ) |
Client* casa::PlotMSAction::client [protected] |
Definition at line 249 of file PlotMSAction.h.
String casa::PlotMSAction::itsDoActionResult_ [protected] |
Result of doAction, if applicable.
Definition at line 254 of file PlotMSAction.h.
Type casa::PlotMSAction::itsType_ [protected] |
Action type.
Definition at line 251 of file PlotMSAction.h.
PMSPTMethod* casa::PlotMSAction::postThreadMethod [protected] |
Definition at line 258 of file PlotMSAction.h.
vector<PlotMSPlot*> casa::PlotMSAction::postThreadObject [protected] |
Definition at line 257 of file PlotMSAction.h.
ThreadController* casa::PlotMSAction::threadController [protected] |
Definition at line 255 of file PlotMSAction.h.
bool casa::PlotMSAction::useThreading [protected] |
Definition at line 244 of file PlotMSAction.h.
1.6.1
