Subclass of PlotMSPlotParameters::Group to handle display parameters. More...

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Display:

Public Member Functions
	PMS_PP_Display (PlotFactoryPtr factory)

	PMS_PP_Display (const PMS_PP_Display &copy)

	~PMS_PP_Display ()

Group *	clone () const
	Abstract Methods //. More...

const casacore::String &	name () const
	Returns the name of this group of subparameters. More...

casacore::Record	toRecord () const
	Returns a casacore::Record representing this group of subparameters. More...

void	fromRecord (const casacore::Record &record)
	Sets the values for this group of subparameters using the given Record. More...

bool	requiresRedrawOnChange () const
	Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise. More...

PMS_PP_Display &	operator= (const Group &other)

PMS_PP_Display &	operator= (const PMS_PP_Display &other)

bool	operator== (const Group &other) const

void	setColorize (const bool &colorize, const PMS::Axis &axis, unsigned int index=0)

void	resizeVectors (unsigned int newSize)

const vector< PlotSymbolPtr > &	unflaggedSymbols () const

void	setUnflaggedSymbols (const vector< PlotSymbolPtr > &value)

PlotSymbolPtr	unflaggedSymbol (unsigned int index=0) const

void	setUnflaggedSymbol (const PlotSymbolPtr &value, unsigned int index=0)

const vector< PlotSymbolPtr > &	flaggedSymbols () const

void	setFlaggedSymbols (const vector< PlotSymbolPtr > &value)

PlotSymbolPtr	flaggedSymbol (unsigned int index=0) const

void	setFlaggedSymbol (const PlotSymbolPtr &value, unsigned int index=0)

const vector< PlotMSLabelFormat > &	titleFormats () const

void	setTitleFormats (const vector< PlotMSLabelFormat > &value)

const PlotMSLabelFormat &	titleFormat (unsigned int index=0) const

void	setTitleFormat (const PlotMSLabelFormat &value, unsigned int index=0)

const vector< bool > &	colorizeFlags () const

void	setColorize (const vector< bool > &value)

bool	colorizeFlag (unsigned int index=0) const

void	setColorize (const bool &value, unsigned int index=0)

const vector< PMS::Axis > &	colorizeAxes () const

void	setColorize (const vector< PMS::Axis > &value)

PMS::Axis	colorizeAxis (unsigned int index=0) const

void	setColorize (const PMS::Axis &value, unsigned int index=0)

void	setConnect (const casacore::String &xconnect, const bool &timeconnect, unsigned int index=0)

const vector< casacore::String > &	xConnects () const

void	setXConnects (const vector< casacore::String > &value)

casacore::String	xConnect (unsigned int index=0) const

void	setXConnect (const casacore::String &value, unsigned int index=0)

const vector< bool > &	timeConnects () const

void	setTimeConnects (const vector< bool > &value)

bool	timeConnect (unsigned int index=0) const

void	setTimeConnect (const bool &value, unsigned int index=0)

Public Member Functions inherited from casa::PlotMSPlotParameters::Group
	Group (PlotFactoryPtr factory)
	Constructor which takes a plot factory. More...

	Group (const Group &copy)
	Copy constructor. More...

virtual	~Group ()
	Destructor. More...

virtual Group &	operator= (const Group &other)
	Implemented Methods //. More...

virtual bool	operator== (const Group &other) const
	Equality operators. More...

virtual bool	operator!= (const Group &other) const

Private Member Functions
PMS_PP_Display &	assign (const PMS_PP_Display *o)

void	setDefaults ()

Private Attributes
vector< PlotSymbolPtr >	itsUnflaggedSymbols_

vector< PlotSymbolPtr >	itsFlaggedSymbols_

vector< PlotMSLabelFormat >	itsTitleFormats_

vector< bool >	itsColorizeFlags_

vector< PMS::Axis >	itsColorizeAxes_

vector< casacore::String >	itsXConnects_

vector< bool >	itsTimeConnects_

Static Private Attributes
static const casacore::String	REC_UNFLAGGEDS

static const casacore::String	REC_FLAGGEDS

static const casacore::String	REC_TITLES

static const casacore::String	REC_COLFLAGS

static const casacore::String	REC_COLAXES

static const casacore::String	REC_XCONNECT

static const casacore::String	REC_TIMECONNECT

Additional Inherited Members
Static Public Member Functions inherited from casa::PlotMSPlotParameters::Group
static void	notifyWatchers (void *obj, bool wasCanceled)
	Post-thread method for notifying watchers that this group has changed. More...

Protected Member Functions inherited from casa::PlotMSPlotParameters::Group
void	updated ()
	Should be called by the child class whenever any of the subparameter values have been updated. More...

void	updated (bool requiresRedraw)

PlotMSPlotParameters *	parent ()
	Returns the parent parameters, or NULL for none. More...

const PlotMSPlotParameters *	parent () const

PlotFactoryPtr	factory ()
	Returns the factory. More...

const PlotFactoryPtr	factory () const

Detailed Description

Subclass of PlotMSPlotParameters::Group to handle display parameters.

Currently includes: flagged and unflagged symbols plot title format colorize flag and axis xconnect and timeconnect (connect points on plot along x- or time-axis) Parameters are vector-based, on a per-plot basis.

Definition at line 1397 of file PlotMSPlotParameterGroups.h.

Constructor & Destructor Documentation

casa::PMS_PP_Display::PMS_PP_Display ( PlotFactoryPtr factory )

Referenced by clone().

casa::PMS_PP_Display::PMS_PP_Display ( const PMS_PP_Display & copy )

casa::PMS_PP_Display::~PMS_PP_Display ( )

Member Function Documentation

PMS_PP_Display& casa::PMS_PP_Display::assign ( const PMS_PP_Display * o )

private

Group* casa::PMS_PP_Display::clone ( ) const

inlinevirtual

Abstract Methods //.

Returns a clone (deep copy) of this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1410 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Display().

const vector< PMS::Axis >& casa::PMS_PP_Display::colorizeAxes ( ) const

inline

Definition at line 1533 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_.

PMS::Axis casa::PMS_PP_Display::colorizeAxis ( unsigned int index = 0 ) const

inline

Definition at line 1542 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_.

bool casa::PMS_PP_Display::colorizeFlag ( unsigned int index = 0 ) const

inline

Definition at line 1526 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_.

const vector< bool >& casa::PMS_PP_Display::colorizeFlags ( ) const

inline

Definition at line 1517 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_.

PlotSymbolPtr casa::PMS_PP_Display::flaggedSymbol ( unsigned int index = 0 ) const

inline

Definition at line 1481 of file PlotMSPlotParameterGroups.h.

References casa::PMS::DEFAULT_FLAGGED_SYMBOL(), casa::PlotMSPlotParameters::Group::factory(), flaggedSymbols(), and itsFlaggedSymbols_.

const vector< PlotSymbolPtr >& casa::PMS_PP_Display::flaggedSymbols ( ) const

inline

Definition at line 1472 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_.

Referenced by flaggedSymbol().

void casa::PMS_PP_Display::fromRecord ( const casacore::Record & record )

virtual

Sets the values for this group of subparameters using the given Record.

Implements casa::PlotMSPlotParameters::Group.

const casacore::String& casa::PMS_PP_Display::name ( ) const

inlinevirtual

Returns the name of this group of subparameters.

Will be used as an update flag.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1415 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_DISPLAY_NAME.

PMS_PP_Display& casa::PMS_PP_Display::operator= ( const Group & other )

PMS_PP_Display& casa::PMS_PP_Display::operator= ( const PMS_PP_Display & other )

bool casa::PMS_PP_Display::operator== ( const Group & other ) const

bool casa::PMS_PP_Display::requiresRedrawOnChange ( ) const

inlinevirtual

Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1427 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Display::resizeVectors ( unsigned int newSize )

void casa::PMS_PP_Display::setColorize	(	const bool &	colorize,
		const PMS::Axis &	axis,
		unsigned int	index = `0`
	)

void casa::PMS_PP_Display::setColorize ( const vector< bool > & value )

inline

Definition at line 1520 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setColorize	(	const bool &	value,
		unsigned int	index = `0`
	)

void casa::PMS_PP_Display::setColorize ( const vector< PMS::Axis > & value )

inline

Definition at line 1536 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setColorize	(	const PMS::Axis &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 1547 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setConnect	(	const casacore::String &	xconnect,
		const bool &	timeconnect,
		unsigned int	index = `0`
	)

void casa::PMS_PP_Display::setDefaults ( )

private

void casa::PMS_PP_Display::setFlaggedSymbol	(	const PlotSymbolPtr &	value,
		unsigned int	index = `0`
	)

void casa::PMS_PP_Display::setFlaggedSymbols ( const vector< PlotSymbolPtr > & value )

inline

Definition at line 1475 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setTimeConnect	(	const bool &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 1596 of file PlotMSPlotParameterGroups.h.

References itsTimeConnects_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setTimeConnects ( const vector< bool > & value )

inline

Definition at line 1585 of file PlotMSPlotParameterGroups.h.

References itsTimeConnects_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setTitleFormat	(	const PlotMSLabelFormat &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 1508 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setTitleFormats ( const vector< PlotMSLabelFormat > & value )

inline

Definition at line 1499 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setUnflaggedSymbol	(	const PlotSymbolPtr &	value,
		unsigned int	index = `0`
	)

void casa::PMS_PP_Display::setUnflaggedSymbols ( const vector< PlotSymbolPtr > & value )

inline

Definition at line 1451 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setXConnect	(	const casacore::String &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 1573 of file PlotMSPlotParameterGroups.h.

References itsXConnects_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

void casa::PMS_PP_Display::setXConnects ( const vector< casacore::String > & value )

inline

Definition at line 1562 of file PlotMSPlotParameterGroups.h.

References itsXConnects_, casa::PlotMSPlotParameters::Group::updated(), and casacore::value().

bool casa::PMS_PP_Display::timeConnect ( unsigned int index = 0 ) const

inline

Definition at line 1591 of file PlotMSPlotParameterGroups.h.

References itsTimeConnects_.

const vector<bool>& casa::PMS_PP_Display::timeConnects ( ) const

inline

Definition at line 1582 of file PlotMSPlotParameterGroups.h.

References itsTimeConnects_.

const PlotMSLabelFormat& casa::PMS_PP_Display::titleFormat ( unsigned int index = 0 ) const

inline

Definition at line 1505 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_.

const vector< PlotMSLabelFormat >& casa::PMS_PP_Display::titleFormats ( ) const

inline

Definition at line 1496 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_.

casacore::Record casa::PMS_PP_Display::toRecord ( ) const

virtual

Returns a casacore::Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

PlotSymbolPtr casa::PMS_PP_Display::unflaggedSymbol ( unsigned int index = 0 ) const

inline

Definition at line 1457 of file PlotMSPlotParameterGroups.h.

References casa::PMS::DEFAULT_UNFLAGGED_SYMBOL(), casa::PlotMSPlotParameters::Group::factory(), itsUnflaggedSymbols_, and unflaggedSymbols().

const vector< PlotSymbolPtr >& casa::PMS_PP_Display::unflaggedSymbols ( ) const

inline

Definition at line 1448 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_.

Referenced by unflaggedSymbol().

casacore::String casa::PMS_PP_Display::xConnect ( unsigned int index = 0 ) const

inline

Definition at line 1568 of file PlotMSPlotParameterGroups.h.

References itsXConnects_, and casacore::String::resize().

const vector<casacore::String>& casa::PMS_PP_Display::xConnects ( ) const

inline

Definition at line 1559 of file PlotMSPlotParameterGroups.h.

References itsXConnects_.

Member Data Documentation

vector<PMS::Axis> casa::PMS_PP_Display::itsColorizeAxes_

private

Definition at line 1616 of file PlotMSPlotParameterGroups.h.

Referenced by colorizeAxes(), colorizeAxis(), and setColorize().

vector<bool> casa::PMS_PP_Display::itsColorizeFlags_

private

Definition at line 1615 of file PlotMSPlotParameterGroups.h.

Referenced by colorizeFlag(), colorizeFlags(), and setColorize().

vector<PlotSymbolPtr> casa::PMS_PP_Display::itsFlaggedSymbols_

private

Definition at line 1613 of file PlotMSPlotParameterGroups.h.

Referenced by flaggedSymbol(), flaggedSymbols(), and setFlaggedSymbols().

vector<bool> casa::PMS_PP_Display::itsTimeConnects_

private

Definition at line 1618 of file PlotMSPlotParameterGroups.h.

Referenced by setTimeConnect(), setTimeConnects(), timeConnect(), and timeConnects().

vector<PlotMSLabelFormat> casa::PMS_PP_Display::itsTitleFormats_

private

Definition at line 1614 of file PlotMSPlotParameterGroups.h.

Referenced by setTitleFormat(), setTitleFormats(), titleFormat(), and titleFormats().

vector<PlotSymbolPtr> casa::PMS_PP_Display::itsUnflaggedSymbols_

private

Definition at line 1612 of file PlotMSPlotParameterGroups.h.

Referenced by setUnflaggedSymbols(), unflaggedSymbol(), and unflaggedSymbols().

vector<casacore::String> casa::PMS_PP_Display::itsXConnects_

private

Definition at line 1617 of file PlotMSPlotParameterGroups.h.

Referenced by setXConnect(), setXConnects(), xConnect(), and xConnects().

const casacore::String casa::PMS_PP_Display::REC_COLAXES

staticprivate

Definition at line 1626 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_COLFLAGS

staticprivate

Definition at line 1625 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_FLAGGEDS

staticprivate

Definition at line 1623 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_TIMECONNECT

staticprivate

Definition at line 1628 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_TITLES

staticprivate

Definition at line 1624 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_UNFLAGGEDS

staticprivate

Definition at line 1622 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Display::REC_XCONNECT

staticprivate

Definition at line 1627 of file PlotMSPlotParameterGroups.h.

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

casa/code/plotms/Plots/PlotMSPlotParameterGroups.h

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation