casa::PlotMSApp Class Reference

Controller class for plotms. More...

#include <PlotMS.h>

Inheritance diagram for casa::PlotMSApp:

Public Member Functions
	PlotMSApp (bool connectToDBus=false, bool userGui=true)
	Default constructor that uses default options.
	PlotMSApp (const PlotMSParameters &params, bool connectToDBus=false, bool userGui=true)
	Constructor which takes the given parameters.
	~PlotMSApp ()
	Destructor.
virtual void	showGUI (bool show=true)
	Plotter Methods //.
virtual bool	guiShown () const
	See PlotMSPlotter::guiShown().
int	execLoop ()
	See PlotMSPlotter::execLoop().
int	showAndExec (bool show=true)
	See PlotMSPlotter::showAndExec().
void	close ()
	See PlotMSPlotter::close().
virtual void	clearPlots ()
	Remove existing plots.
void	showError (const String &message, const String &title="PlotMS Error", bool isWarning=false)
	See PlotMSPlotter::showError().
void	showWarning (const String &message, const String &title="PlotMS Warning")
void	clearMessage ()
void	showMessage (const String &message, const String &title="PlotMS Message")
	See PlotMSPlotter::showMessage().
void	setAnnotationModeActive (PlotMSAction::Type type, bool active)
	Enable/disable annotations in the client.
void	resetTools ()
	Enables/disables tool settings on the canvases based on GUI settings.
virtual PlotMSParameters &	getParameters ()
	Parameter Methods //.
void	setParameters (const PlotMSParameters &params)
virtual PlotMSExportParam &	getExportParameters ()
	Gets/Sets the export parameters for this PlotMS.
void	setExportParameters (const PlotMSExportParam &params)
PlotExportFormat	getExportFormat ()
void	setExportFormat (const PlotExportFormat format)
void	parametersHaveChanged (const PlotMSWatchedParameters &params, int updateFlag)
	Implements PlotMSParametersWatcher::parametersHaveChanged().
virtual PlotSymbolPtr	createSymbol (const String &descriptor, Int size, const String &color, const String &fillPattern, bool outline)
	Symbols.
PlotSymbolPtr	createSymbol (const PlotSymbolPtr &copy)
virtual PlotLoggerPtr	getLogger ()
	Logger Methods //.
virtual PlotMSPlotManager &	getPlotManager ()
	Plot Management Methods //.
PlotMSPlot *	addOverPlot (const PlotMSPlotParameters *p=NULL)
	See PlotMSPlotManager::addOverPlot();.
virtual bool	isDrawing () const
bool	isClosed () const
void	setOperationCompleted (bool completed)
	Set whether the latest plot update was successful completed.
bool	save (const PlotExportFormat &format)
	save plot to file using specified format.
virtual PlotFactoryPtr	getPlotFactory ()
	PlotEngine methods.
virtual void	quitApplication ()
virtual PlotMSFlagging	getFlagging () const
virtual void	setFlagging (PlotMSFlagging flag)
void	canvasAdded (PlotCanvasPtr canvas)
bool	isVisible (PlotCanvasPtr &canvas)
bool	exportToFormat (const PlotExportFormat &format)
virtual Record	locateInfo (Bool &success, String &errorMessage)
bool	isOperationCompleted () const
	Returns whether or not the latest plot update completed successfully.
PlotterPtr	getPlotter ()
bool	updateCachePlot (PlotMSPlot plot, void(f)(void *, bool), bool setupPlot)
void	setCommonAxes (bool commonX, bool commonY)
bool	isCommonAxisX () const
bool	isCommonAxisY () const
void	setAxisLocation (PlotAxis locationX, PlotAxis locationY)
PlotAxis	getAxisLocationX () const
PlotAxis	getAxisLocationY () const
vector< String >	getFiles () const
Public Attributes
bool	its_want_avoid_popups
	To allow normal error/warning/info popups, which block execution, or, if not, prevent blocking by writing to the Logger and posting text to a status bar (or other visible gui element TBD) (public for now, while it's experimental).
Private Member Functions
void	initialize (bool connectToDBus, bool userGui)
	Initializes a new PlotMS object, to be called from constructor.
	PlotMSApp (const PlotMSApp &copy)
	Disable copy constructor and operator for now.
PlotMSApp &	operator= (const PlotMSApp &copy)
Private Attributes
Client *	itsPlotter_
	Plotter, Script or GUI.
Client *	itsLastPlotter_
bool	isGUI_
PlotMSParameters	itsParameters_
	Current parameters.
PlotMSExportParam	itsExportParameters_
PlotExportFormat	itsExportFormat
PlotLoggerPtr	itsLogger_
	Logger.
PlotMSPlotManager	itsPlotManager_
	Plot manager.
PlotMSDBusApp *	itsDBus_
	DBus application, or NULL if one is not needed.
bool	operationCompleted
	Whether the most recent plot updated was successfully completed.

Detailed Description

Controller class for plotms.

Handles interactions between the UI and plots.

Definition at line 52 of file PlotMS.h.

Constructor & Destructor Documentation

casa::PlotMSApp::PlotMSApp	(	bool	connectToDBus = `false`,
		bool	userGui = `true`
	)

Default constructor that uses default options.

If connectToDBus is true, then the application registers itself with CASA's DBus server using the PlotMSDBusApp::dbusName() with the current process ID.

casa::PlotMSApp::PlotMSApp	(	const PlotMSParameters &	params,
		bool	connectToDBus = `false`,
		bool	userGui = `true`
	)

Constructor which takes the given parameters.

If connectToDBus is true, then the application registers itself with CASA's DBus server using the PlotMSDBusApp::dbusName() with the current process ID.

casa::PlotMSApp::~PlotMSApp ( )

Destructor.

casa::PlotMSApp::PlotMSApp ( const PlotMSApp & copy ) [private]

Disable copy constructor and operator for now.

Member Function Documentation

PlotMSPlot* casa::PlotMSApp::addOverPlot ( const PlotMSPlotParameters * p = NULL ) [virtual]

virtual PlotSymbolPtr casa::PlotMSApp::createSymbol	(	const String &	descriptor,
		Int	size,
		const String &	color,
		const String &	fillPattern,
		bool	outline
	)			`[virtual]`

void casa::PlotMSApp::initialize	(	bool	connectToDBus,
		bool	userGui
	)			`[private]`

virtual Record casa::PlotMSApp::locateInfo	(	Bool &	success,
		String &	errorMessage
	)			`[virtual]`

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

void casa::PlotMSApp::setAnnotationModeActive	(	PlotMSAction::Type	type,
		bool	active
	)

void casa::PlotMSApp::setAxisLocation	(	PlotAxis	locationX,
		PlotAxis	locationY
	)

void casa::PlotMSApp::setCommonAxes	(	bool	commonX,
		bool	commonY
	)

void casa::PlotMSApp::showError	(	const String &	message,
		const String &	title = `"PlotMS Error"`,
		bool	isWarning = `false`
	)

void casa::PlotMSApp::showMessage	(	const String &	message,
		const String &	title = `"PlotMS Message"`
	)

void casa::PlotMSApp::showWarning	(	const String &	message,
		const String &	title = `"PlotMS Warning"`
	)

bool casa::PlotMSApp::updateCachePlot	(	PlotMSPlot *	plot,
		void()(void , bool)	f,
		bool	setupPlot
	)

casa::PlotMSApp Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation