ABSTRACT CLASSES //. More...

#include <PlotMSAction.h>

Inheritance diagram for casa::PlotMSAction:

Public Types
enum	Type { SEL_FLAG, SEL_UNFLAG, SEL_LOCATE, SEL_INFO, SEL_CLEAR_REGIONS, ITER_FIRST, ITER_PREV, ITER_NEXT, ITER_LAST, TOOL_MARK_REGIONS, TOOL_SUBTRACT_REGIONS, TOOL_ZOOM, TOOL_PAN, TOOL_ANNOTATE_TEXT, TOOL_ANNOTATE_RECTANGLE, TOOL_FLAG_ALL, TRACKER_ENABLE_HOVER, TRACKER_ENABLE_DISPLAY, STACK_BACK, STACK_BASE, STACK_FORWARD, CACHE_LOAD, CACHE_RELEASE, MS_SUMMARY, SUMMARY_DIALOG, PLOT, PLOT_EXPORT, EXPORT_DIALOG, HOLD_RELEASE_DRAWING, CLEAR_PLOTTER, QUIT, OPEN }
	Static // Enum for implemented actions. More...

Public Member Functions
	PlotMSAction (Client client, PMSPTMethod postThreadMethod=NULL, std::vector< PlotMSPlot > postThreadObject=std::vector< PlotMSPlot * >())
	Non-Static //. More...

virtual	~PlotMSAction ()
	Destructor. More...

bool	doAction (PlotMSApp *plotms)
	Performs the action, using the given PlotMSApp, and returns true for success or false or failure. More...

void	setUseThreading (bool useThread)

virtual bool	doActionWithResponse (PlotMSApp *plotms, casacore::Record &retval)

const casacore::String &	doActionResult () const
	Returns the result of doAction(), if applicable. More...

Protected Member Functions
virtual bool	loadParameters ()

virtual bool	doActionSpecific (PlotMSApp *plotms)=0

void	setUpClientCommunication (BackgroundThread *thread, int index)

bool	initiateWork (BackgroundThread *thread)

Protected Attributes
bool	useThreading

Client *	client

Type	itsType_
	Action type. More...

casacore::String	itsDoActionResult_
	Result of doAction, if applicable. More...

ThreadController *	threadController

std::vector< PlotMSPlot * >	postThreadObject

PMSPTMethod *	postThreadMethod

Private Member Functions
bool	isValid ()
	Returns true if the action is valid or not. More...

	PlotMSAction (const PlotMSAction &other)

Detailed Description

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, casacore::String, int, and vector<PMS::Axis>.

Definition at line 47 of file PlotMSAction.h.

Member Enumeration Documentation

enum casa::PlotMSAction::Type

Static // Enum for implemented actions.

Enumerator
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
TOOL_FLAG_ALL	Turns on/off the per-panel flagging tool.
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	casacore::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 casacore::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.

Constructor & Destructor Documentation

casa::PlotMSAction::PlotMSAction	(	Client *	client,
		PMSPTMethod	postThreadMethod = `NULL`,
		std::vector< PlotMSPlot * >	postThreadObject = `std::vector< PlotMSPlot * >()`
	)

Non-Static //.

Constructor.

virtual casa::PlotMSAction::~PlotMSAction ( )

virtual

Destructor.

casa::PlotMSAction::PlotMSAction ( const PlotMSAction & other )

private

Member Function Documentation

bool casa::PlotMSAction::doAction ( PlotMSApp * plotms )

Performs the action, using the given PlotMSApp, and returns true for success or false or failure.

const casacore::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 )

protectedpure virtual

Implemented in casa::ActionCache, casa::ActionSummaryDialog, casa::ActionExportDialog, casa::ActionTool, casa::ActionTracker, casa::ActionSummary, casa::ActionExport, casa::ActionSelect, casa::ActionStack, casa::ActionInformation, casa::ActionHoldReleaseDrawing, casa::ActionQuit, casa::ActionIterPrev, casa::ActionPlot, casa::ActionClearRegions, casa::ActionIterFirst, casa::ActionIterLast, casa::ActionClearPlotter, and casa::ActionIterNext.

virtual bool casa::PlotMSAction::doActionWithResponse	(	PlotMSApp *	plotms,
		casacore::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 ( )

protectedvirtual

Reimplemented in casa::ActionTool, casa::ActionCache, casa::ActionSummary, casa::ActionExport, casa::ActionTracker, and casa::ActionHoldReleaseDrawing.

void casa::PlotMSAction::setUpClientCommunication	(	BackgroundThread *	thread,
		int	index
	)

protected

void casa::PlotMSAction::setUseThreading ( bool useThread )

Member Data Documentation

Client* casa::PlotMSAction::client

protected

Definition at line 252 of file PlotMSAction.h.

casacore::String casa::PlotMSAction::itsDoActionResult_

protected

Result of doAction, if applicable.

Definition at line 257 of file PlotMSAction.h.

Type casa::PlotMSAction::itsType_

protected

Action type.

Definition at line 254 of file PlotMSAction.h.

PMSPTMethod* casa::PlotMSAction::postThreadMethod

protected

Definition at line 261 of file PlotMSAction.h.

std::vector<PlotMSPlot*> casa::PlotMSAction::postThreadObject

protected

Definition at line 260 of file PlotMSAction.h.

ThreadController* casa::PlotMSAction::threadController

protected

Definition at line 258 of file PlotMSAction.h.

bool casa::PlotMSAction::useThreading

protected

Definition at line 247 of file PlotMSAction.h.

The documentation for this class was generated from the following file:

casa/code/plotms/Actions/PlotMSAction.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation