casa::PlotMSDBusApp Class Reference

#include <PlotMSDBusApp.h>

Inheritance diagram for casa::PlotMSDBusApp:

Public Member Functions
QString	dbusName () const
	PlotMSDBusApp (PlotEngine &plotms)
	Non-Static //.
	~PlotMSDBusApp ()
	Destructor.
bool	connectToDBus (const QString &dbus_name="")
	Connects to the DBus server using the dbusName() method with the current process ID.
void	parametersHaveChanged (const PlotMSWatchedParameters &params, int updateFlag)
	Implements PlotMSParametersWatcher::parametersHaveChanged().
void	plotsChanged (const PlotMSPlotManager &manager)
	Implements PlotMSPlotManagerWatcher::plotsChanged().
Static Public Member Functions
static const QString &	name ()
static String	dbusName (pid_t pid)
	Returns the name that the plotms in the process with the given ID is (or would be) registered with in the CASA DBus server.
Static Public Attributes
static const String	APP_NAME
	Static //.
static const String	APP_CASAPY_SWITCH
static const String	APP_LOGFILENAME_SWITCH
static const String	APP_LOGFILTER_SWITCH
static const String	PARAM_AVERAGING
	PARAMETERS //.
static const String	PARAM_AXIS_X
static const String	PARAM_AXIS_Y
static const String	PARAM_AXIS_Y_LOCATION
static const String	PARAM_GRIDROWS
static const String	PARAM_GRIDCOLS
static const String	PARAM_CLEARSELECTIONS
static const String	PARAM_DATACOLUMN_X
static const String	PARAM_DATACOLUMN_Y
static const String	PARAM_FILENAME
static const String	PARAM_FLAGGING
static const String	PARAM_HEIGHT
static const String	PARAM_ITERATE
static const String	PARAM_PLOTINDEX
static const String	PARAM_PRIORITY
static const String	PARAM_SELECTION
static const String	PARAM_TRANSFORMATIONS
static const String	PARAM_CALIBRATION
static const String	PARAM_UPDATEIMMEDIATELY
static const String	PARAM_WIDTH
static const String	PARAM_EXPORT_FILENAME
static const String	PARAM_EXPORT_FORMAT
static const String	PARAM_EXPORT_RANGE
static const String	PARAM_EXPORT_HIGHRES
static const String	PARAM_EXPORT_DPI
static const String	PARAM_EXPORT_WIDTH
static const String	PARAM_EXPORT_HEIGHT
static const String	PARAM_EXPORT_INTERACTIVE
static const String	PARAM_EXPORT_ASYNC
static const String	PARAM_COLORIZE
static const String	PARAM_COLORAXIS
static const String	PARAM_CANVASTITLE
static const String	PARAM_CANVASTITLEFONT
static const String	PARAM_DATA_INDEX
static const String	PARAM_XAXISLABEL
static const String	PARAM_YAXISLABEL
static const String	PARAM_XAXISFONT
static const String	PARAM_YAXISFONT
static const String	PARAM_SHOWMAJORGRID
static const String	PARAM_SHOWMINORGRID
static const String	PARAM_MAJORCOLOR
static const String	PARAM_MINORCOLOR
static const String	PARAM_MAJORSTYLE
static const String	PARAM_MINORSTYLE
static const String	PARAM_MAJORWIDTH
static const String	PARAM_MINORWIDTH
static const String	PARAM_SHOWLEGEND
static const String	PARAM_LEGENDPOSITION
static const String	PARAM_XAUTORANGE
static const String	PARAM_XMIN
static const String	PARAM_XMAX
static const String	PARAM_YAUTORANGE
static const String	PARAM_YMIN
static const String	PARAM_YMAX
static const String	PARAM_SYMBOL
static const String	PARAM_SYMBOLSHAPE
static const String	PARAM_SYMBOLSIZE
static const String	PARAM_SYMBOLCOLOR
static const String	PARAM_SYMBOLFILL
static const String	PARAM_SYMBOLOUTLINE
static const String	PARAM_FLAGGEDSYMBOL
static const String	PARAM_FLAGGEDSYMBOLSHAPE
static const String	PARAM_FLAGGEDSYMBOLSIZE
static const String	PARAM_FLAGGEDSYMBOLCOLOR
static const String	PARAM_FLAGGEDSYMBOLFILL
static const String	PARAM_FLAGGEDSYMBOLOUTLINE
static const String	METHOD_GETLOGPARAMS
	DBus method name for getting the log parameters, including: the sink filename (PARAM_FILENAME) and the filter priority (PARAM_PRIORITY).
static const String	METHOD_SETLOGPARAMS
	DBus method name for setting the log parameters, using a Record with zero or more of the parameters set (see METHOD_GETLOGPARAMS).
static const String	METHOD_GETPLOTMSPARAMS
	DBus method name for getting the plotms parameters, including: the "clear selections on axes change" flag (PARAM_CLEARSELECTIONS), and the cached image width (PARAM_WIDTH) and height (PARAM_HEIGHT).
static const String	METHOD_SETPLOTMSPARAMS
	DBus method name for setting the plotms parameters, using a Record with zero or more of the parameters set (see METHOD_GETPLOTMSPARAMS).
static const String	METHOD_SETCACHEDIMAGESIZETOSCREENRES
	DBus method name for setting the cached image size to the current screen resolution.
static const String	METHOD_GETPLOTPARAMS
	DBus method name for getting the plot parameters at the given index (PARAM_PLOTINDEX), including: the MS filename (PARAM_FILENAME), the x axis (PARAM_AXIS_X) and data column (PARAM_DATACOLUMN_X), the y axis (PARAM_AXIS_Y) and data column (PARAM_DATACOLUMN_Y), averaging (PARAM_AVERAGING), selection (PARAM_SELECTION), transformations (PARAM_TRANSFORMATIONS), and calibration (PARAM_CALIBRATION) PARAMETERS: plot index.
static const String	METHOD_SETPLOTPARAMS
	DBus method name for setting the plot parameters at the given index (PARAM_PLOTINDEX), using a Record with zero or more of the parameters set (see METHOD_GETPLOTPARAMS).
static const String	METHOD_SETEXPORTPARAMS
	Sets the export parameters.
static const String	METHOD_GETFLAGGING
	DBus method name for getting the flag extension parameters (PARAM_FLAGGING).
static const String	METHOD_SETFLAGGING
	DBus method name for setting the flag extension parameters.
static const String	METHOD_SHOW
	DBus method names for showing/hiding the window.
static const String	METHOD_HIDE
static const String	METHOD_UPDATE
	DBus method name for updating the running PlotMS with any attributes that were set with updateImmediately = false.
static const String	METHOD_CLEARPLOTS
	Existing plots should be removed.
static const String	METHOD_QUIT
	DBus method name for quitting the entire application.
static const String	METHOD_SAVE
	DBus method name for exporting plot file.
static const String	METHOD_ISDRAWING
	DBus method name for determining if a plot is being drawn.
static const String	METHOD_ISCLOSED
	is the top widget still shown
static const String	METHOD_LOCATEINFO
	DBus method name for locating points in a specified region PARAMETERS: upper left and lower right bounding box coordinates RETURNS: meta data of located points (Record).
Protected Member Functions
void	dbusRunXmlMethod (const String &methodName, const Record &parameters, Record &retValue, const String &callerName, bool isAsync)
	Implements QtDBusXmlApp::dbusRunXmlMethod().
void	dbusXmlReceived (const QtDBusXML &xml)
	Overrides QtDBusXmlApp::dbusXmlReceived() to print the message to the log as needed.
Private Member Functions
void	log (const String &message)
	Helper method for posting log messages.
bool	plotParameters (int &plotIndex) const
	Adjusts the given plot index to be an acceptable, and returns whether the parameters were resized or not.
bool	update ()
	Helper for updating.
bool	_savePlot (const Record &parameters)
	helper for saving
Record	_locateInfo (const Record &parameters)
	helper for locate
bool	checkPlotIndex (int index)
	Make sure users don't set the plot index to an invalid value.
Private Attributes
PlotEngine &	itsPlotms_
	Parent PlotMS.
PlotMSParameters	itsParams_
	Set PlotMS parameters that haven't yet been transferred to the current PlotMS.
vector< PlotMSPlotParameters >	itsPlotParams_
	Set PlotMSSinglePlot parameters that haven't yet been transfered to the current PlotMS.
bool	itsUpdateFlag_
	Flag for whether to call update() during show() or not.
Friends
class	PlotMSDBusAppWatcher

Detailed Description

class PlotEngine;

Subclass of QtDBusXmlApp to control plotms using DBus communication.

Definition at line 42 of file PlotMSDBusApp.h.

Constructor & Destructor Documentation

casa::PlotMSDBusApp::PlotMSDBusApp ( PlotEngine & plotms )

Non-Static //.

Constructor which takes PlotMS parent object.

casa::PlotMSDBusApp::~PlotMSDBusApp ( )

Destructor.

Member Function Documentation

Record casa::PlotMSDBusApp::_locateInfo ( const Record & parameters ) [private]

helper for locate

bool casa::PlotMSDBusApp::_savePlot ( const Record & parameters ) [private]

helper for saving

bool casa::PlotMSDBusApp::checkPlotIndex ( int index ) [private]

Make sure users don't set the plot index to an invalid value.

bool casa::PlotMSDBusApp::connectToDBus ( const QString & dbus_name = "" ) [virtual]

Connects to the DBus server using the dbusName() method with the current process ID.

Returns whether the connection succeeded or not.

Implements casa::QtDBusApp.

static String casa::PlotMSDBusApp::dbusName ( pid_t pid ) [static]

Returns the name that the plotms in the process with the given ID is (or would be) registered with in the CASA DBus server.

QString casa::PlotMSDBusApp::dbusName ( ) const [inline, virtual]

Implements casa::QtDBusApp.

Definition at line 51 of file PlotMSDBusApp.h.

References name().

void casa::PlotMSDBusApp::dbusRunXmlMethod	(	const String &	methodName,
		const Record &	parameters,
		Record &	retValue,
		const String &	callerName,
		bool	isAsync
	)			`[protected, virtual]`

Implements QtDBusXmlApp::dbusRunXmlMethod().

Implements casa::QtDBusXmlApp.

void casa::PlotMSDBusApp::dbusXmlReceived ( const QtDBusXML & xml ) [protected, virtual]

Overrides QtDBusXmlApp::dbusXmlReceived() to print the message to the log as needed.

Reimplemented from casa::QtDBusXmlApp.

void casa::PlotMSDBusApp::log ( const String & message ) [private]

Helper method for posting log messages.

static const QString& casa::PlotMSDBusApp::name ( ) [static]

Referenced by dbusName().

void casa::PlotMSDBusApp::parametersHaveChanged	(	const PlotMSWatchedParameters &	params,
		int	updateFlag
	)			`[virtual]`

Implements PlotMSParametersWatcher::parametersHaveChanged().

Implements casa::PlotMSParametersWatcher.

bool casa::PlotMSDBusApp::plotParameters ( int & plotIndex ) const [private]

Adjusts the given plot index to be an acceptable, and returns whether the parameters were resized or not.

void casa::PlotMSDBusApp::plotsChanged ( const PlotMSPlotManager & manager ) [virtual]

Implements PlotMSPlotManagerWatcher::plotsChanged().

Implements casa::PlotMSPlotManagerWatcher.

bool casa::PlotMSDBusApp::update ( ) [private]

Helper for updating.

Friends And Related Function Documentation

friend class PlotMSDBusAppWatcher [friend]

Definition at line 46 of file PlotMSDBusApp.h.

Member Data Documentation

const String casa::PlotMSDBusApp::APP_CASAPY_SWITCH [static]

Definition at line 58 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::APP_LOGFILENAME_SWITCH [static]

Definition at line 59 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::APP_LOGFILTER_SWITCH [static]

Definition at line 60 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::APP_NAME [static]

Static //.

Constants for the casaplotms standalone executable.

Definition at line 57 of file PlotMSDBusApp.h.

PlotMSParameters casa::PlotMSDBusApp::itsParams_ [private]

Set PlotMS parameters that haven't yet been transferred to the current PlotMS.

Definition at line 284 of file PlotMSDBusApp.h.

PlotEngine& casa::PlotMSDBusApp::itsPlotms_ [private]

Parent PlotMS.

PlotMSApp& itsPlotms_;

Definition at line 280 of file PlotMSDBusApp.h.

vector<PlotMSPlotParameters> casa::PlotMSDBusApp::itsPlotParams_ [private]

Set PlotMSSinglePlot parameters that haven't yet been transfered to the current PlotMS.

Definition at line 288 of file PlotMSDBusApp.h.

bool casa::PlotMSDBusApp::itsUpdateFlag_ [private]

Flag for whether to call update() during show() or not.

This will be true if the user updates something while the GUI is hidden.

Definition at line 292 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_CLEARPLOTS [static]

Existing plots should be removed.

PARAMETERS: none. RETURNS: none.

Definition at line 220 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_GETFLAGGING [static]

DBus method name for getting the flag extension parameters (PARAM_FLAGGING).

PARAMETERS: none. RETURNS: value (Record), unless invalid or run asynchronously.

Definition at line 195 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_GETLOGPARAMS [static]

DBus method name for getting the log parameters, including: the sink filename (PARAM_FILENAME) and the filter priority (PARAM_PRIORITY).

PARAMETERS: none. RETURNS: value (Record), unless invalid or run asynchronously.

Definition at line 142 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_GETPLOTMSPARAMS [static]

DBus method name for getting the plotms parameters, including: the "clear selections on axes change" flag (PARAM_CLEARSELECTIONS), and the cached image width (PARAM_WIDTH) and height (PARAM_HEIGHT).

PARAMETERS: none. RETURNS: value (Record), unless invalid or run asynchronously.

Definition at line 155 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_GETPLOTPARAMS [static]

DBus method name for getting the plot parameters at the given index (PARAM_PLOTINDEX), including: the MS filename (PARAM_FILENAME), the x axis (PARAM_AXIS_X) and data column (PARAM_DATACOLUMN_X), the y axis (PARAM_AXIS_Y) and data column (PARAM_DATACOLUMN_Y), averaging (PARAM_AVERAGING), selection (PARAM_SELECTION), transformations (PARAM_TRANSFORMATIONS), and calibration (PARAM_CALIBRATION) PARAMETERS: plot index.

RETURNS: value (Record), unless invalid or run asynchronously.

Definition at line 177 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_HIDE [static]

Definition at line 208 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_ISCLOSED [static]

is the top widget still shown

Definition at line 235 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_ISDRAWING [static]

DBus method name for determining if a plot is being drawn.

Definition at line 232 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_LOCATEINFO [static]

DBus method name for locating points in a specified region PARAMETERS: upper left and lower right bounding box coordinates RETURNS: meta data of located points (Record).

Definition at line 240 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_QUIT [static]

DBus method name for quitting the entire application.

PARAMETERS: none. RETURNS: none.

Definition at line 225 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SAVE [static]

DBus method name for exporting plot file.

Definition at line 229 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETCACHEDIMAGESIZETOSCREENRES [static]

DBus method name for setting the cached image size to the current screen resolution.

PARAMETERS: none. RETURNS: none.

Definition at line 167 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETEXPORTPARAMS [static]

Sets the export parameters.

PARAMETERS: value (Record). RETURNS: none.

Definition at line 189 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETFLAGGING [static]

DBus method name for setting the flag extension parameters.

PARAMETERS: flagging value. RETURNS: none.

Definition at line 200 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETLOGPARAMS [static]

DBus method name for setting the log parameters, using a Record with zero or more of the parameters set (see METHOD_GETLOGPARAMS).

PARAMETERS: value (Record). RETURNS: none.

Definition at line 148 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETPLOTMSPARAMS [static]

DBus method name for setting the plotms parameters, using a Record with zero or more of the parameters set (see METHOD_GETPLOTMSPARAMS).

PARAMETERS: value (Record). RETURNS: none.

Definition at line 161 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SETPLOTPARAMS [static]

DBus method name for setting the plot parameters at the given index (PARAM_PLOTINDEX), using a Record with zero or more of the parameters set (see METHOD_GETPLOTPARAMS).

PARAMETERS: value (Record). RETURNS: none.

Definition at line 184 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_SHOW [static]

DBus method names for showing/hiding the window.

Does NOT quit the entire application. PARAMETERS: none. RETURNS: none.

Definition at line 207 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::METHOD_UPDATE [static]

DBus method name for updating the running PlotMS with any attributes that were set with updateImmediately = false.

PARAMETERS: none. RETURNS: none.

Definition at line 215 of file PlotMSDBusApp.h.

const String casa::PlotMSDBusApp::PARAM_AVERAGING [static]

PARAMETERS //.