Hooks for applications to write custom code that follows the standard TablePlot behaviour. More...

#include <TPCallBackHooks.h>

Inheritance diagram for casa::TPGuiCallBackHooks:

Public Member Functions
	TPGuiCallBackHooks ()
	Constructor.
virtual	~TPGuiCallBackHooks ()
	Destructor.
virtual Vector< String >	getLocateColumns ()
	Specify a list of Table column names to use for the "locate" function This function is used by TablePlot to decide which columns to "locate" on.
virtual Bool	printlocateinfo (Vector< String > collist, Matrix< Double > infomat, Vector< String > cpol)
	After the standard TP Locate function call, this method is called during printing the results, to accomodate custom formatting.
virtual Bool	flagdata (String)
	After the standard TP flagdata function, this method is called (per BasePlot/Table) so any external flag-propagation can be carried out Called from TablePlot::flagData.
virtual Bool	flagdata (Int, Vector< String >, Matrix< Double >, Vector< String >, Bool=False)
virtual Bool	releasetable (Int, Int, Int, String)
	During the standard TP clearPlot, this function is called immediately after each BasePlot destructor.
virtual Bool	createiterplotlabels (Vector< String > iteraxes, Vector< Double > values, String &titlestring)
	A function to allow the creation of customized labels for iteration plot panels.
Protected Attributes
Vector< String >	LocateColumns

Detailed Description

Hooks for applications to write custom code that follows the standard TablePlot behaviour.

Prerequisite

TablePlot

Etymology

Hooks into TablePlot callback functions that are triggered from the GUI.

Synopsis

TablePlot functions are called directly via the Python-C++ binding, when GUI buttons are pressed. These callbacks provide a way for the user-application to customize the response to GUI-initiated operations. These callbacks are called from fixed points in the TablePlot code. If a user application needs to implement any callbacks, an instance of this class (or one derived from it) needs to be sent in to TablePlot as a Plot Option.

Hooks have been provided for - (un)flagdata - locatedata - clearplot These functions are stored in, and called from each BasePlot.

Motivation

User apps need to be able to customize some behaviour that is initiated by GUI events.

Thrown Exceptions

To Do

Definition at line 172 of file TPCallBackHooks.h.

Constructor & Destructor Documentation

casa::TPGuiCallBackHooks::TPGuiCallBackHooks ( ) [inline]

Constructor.

Definition at line 176 of file TPCallBackHooks.h.

References LocateColumns, and casa::Vector< T >::resize().

virtual casa::TPGuiCallBackHooks::~TPGuiCallBackHooks ( ) [inline, virtual]

Destructor.

Definition at line 179 of file TPCallBackHooks.h.

Member Function Documentation

virtual Bool casa::TPGuiCallBackHooks::createiterplotlabels	(	Vector< String >	iteraxes,
		Vector< Double >	values,
		String &	titlestring
	)		`[inline, virtual]`

A function to allow the creation of customized labels for iteration plot panels.

Called from TablePlot::iterMultiPlotNext.

Reimplemented in casa::MSPlotMainMSCallBack, and casa::PlotCalCallBacks.

Definition at line 248 of file TPCallBackHooks.h.

References casa::ArrayBase::nelements(), String, casa::vpf::toString(), and casa::True.

virtual Bool casa::TPGuiCallBackHooks::flagdata ( String ) [inline, virtual]

After the standard TP flagdata function, this method is called (per BasePlot/Table) so any external flag-propagation can be carried out Called from TablePlot::flagData.

Reimplemented in casa::PlotCalCallBacks.

Definition at line 230 of file TPCallBackHooks.h.

References casa::True.

virtual Bool casa::TPGuiCallBackHooks::flagdata	(	Int	,
		Vector< String >	,
		Matrix< Double >	,
		Vector< String >	,
		Bool	= `False`
	)		`[inline, virtual]`

Definition at line 231 of file TPCallBackHooks.h.

References casa::True.

virtual Vector<String> casa::TPGuiCallBackHooks::getLocateColumns ( ) [inline, virtual]

Specify a list of Table column names to use for the "locate" function This function is used by TablePlot to decide which columns to "locate" on.

Called from PanelParams.cc : PlotOption::validataParams();

Definition at line 185 of file TPCallBackHooks.h.

References LocateColumns.

virtual Bool casa::TPGuiCallBackHooks::printlocateinfo	(	Vector< String >	collist,
		Matrix< Double >	infomat,
		Vector< String >	cpol
	)		`[inline, virtual]`

After the standard TP Locate function call, this method is called during printing the results, to accomodate custom formatting.

Called from TablePlot::dumpLocateInfo(). The number of rows in the Matrix are the number of table rows selected by the locate regions. The Matrix (infomat) contains n+2 columns, where n = LocateColumns.nelements(). column 0 contains the row number. column 1 contains the number of points selected per row The rest of the columns are values for LocateColumns. The String (cpol) contains information about selected cellrows/cellcols. (chans/pols).

Reimplemented in casa::PlotCalCallBacks.

Definition at line 201 of file TPCallBackHooks.h.

References casa::utilj::contains(), casa::C::day, casa::MVTime::DMY, casa::LogMessage::NORMAL4, casa::SLog::out(), casa::Matrix< T >::shape(), casa::SLog::slog(), casa::MVTime::string(), and casa::True.