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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Axes:

Public Member Functions
	PMS_PP_Axes (PlotFactoryPtr factory)

	PMS_PP_Axes (const PMS_PP_Axes &copy)

	~PMS_PP_Axes ()

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_Axes &	operator= (const PMS_PP_Axes &other)

PMS_PP_Axes &	operator= (const Group &other)

bool	operator== (const Group &other) const

unsigned int	numXAxes () const
	Gets how many axes there are. More...

unsigned int	numYAxes () const

void	setAxes (const PlotAxis &xAxis, const PlotAxis &yAxis, unsigned int index=0)
	Sets single versions of the parameters for the given index. More...

void	setXRange (const bool &set, const prange_t &range, unsigned int index=0)

void	setYRange (const bool &set, const prange_t &range, unsigned int index=0)

void	setRanges (const bool &xSet, const bool &ySet, const prange_t &xRange, const prange_t &yRange, unsigned int index=0)

const vector< PlotAxis > &	xAxes () const

void	setXAxes (const vector< PlotAxis > &value)

PlotAxis	xAxis (unsigned int index=0) const

void	setXAxis (const PlotAxis &value, unsigned int index=0)

const std::vector< PlotAxis > &	yAxes () const

void	setYAxes (const vector< PlotAxis > &value)

PlotAxis	yAxis (unsigned int index=0) const

void	setYAxis (const PlotAxis &value, unsigned int index=0)

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

const std::vector< bool > &	xRangesSet () const

void	setXRanges (const vector< bool > &value)

bool	xRangeSet (unsigned int index=0) const

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

const vector< bool > &	yRangesSet () const

void	setYRanges (const vector< bool > &value)

bool	yRangeSet (unsigned int index=0) const

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

const vector< prange_t > &	xRanges () const

void	setXRanges (const vector< prange_t > &value)

const prange_t &	xRange (unsigned int index=0) const

void	setXRange (const prange_t &value, unsigned int index=0)

const vector< prange_t > &	yRanges () const

void	setYRanges (const vector< prange_t > &value)

const prange_t &	yRange (unsigned int index=0) const

void	setYRange (const prange_t &value, unsigned int index=0)

void	resize (int count, bool copyValues=False)
	Change the size of the vectors. More...

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_Axes &	assign (const PMS_PP_Axes *o)
	Does the work for operator=()s. More...

void	setDefaults ()

Private Attributes
std::vector< PlotAxis >	itsXAxes_

std::vector< PlotAxis >	itsYAxes_

std::vector< bool >	itsXRangesSet_

std::vector< bool >	itsYRangesSet_

std::vector< prange_t >	itsXRanges_

std::vector< prange_t >	itsYRanges_

Static Private Attributes
static const casacore::String	REC_XAXES

static const casacore::String	REC_YAXES

static const casacore::String	REC_XRANGESSET

static const casacore::String	REC_YRANGESSET

static const casacore::String	REC_XRANGES

static const casacore::String	REC_YRANGES

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 axes parameters.

Currently includes: canvas attach axes axes ranges, if any Parameters are vector-based, on a per-plot basis.

Definition at line 626 of file PlotMSPlotParameterGroups.h.

Constructor & Destructor Documentation

casa::PMS_PP_Axes::PMS_PP_Axes ( PlotFactoryPtr factory )

Referenced by clone().

casa::PMS_PP_Axes::PMS_PP_Axes ( const PMS_PP_Axes & copy )

casa::PMS_PP_Axes::~PMS_PP_Axes ( )

Member Function Documentation

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

private

Does the work for operator=()s.

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

inlinevirtual

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 639 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Axes().

void casa::PMS_PP_Axes::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_Axes::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 644 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_AXES_NAME.

unsigned int casa::PMS_PP_Axes::numXAxes ( ) const

Gets how many axes there are.

unsigned int casa::PMS_PP_Axes::numYAxes ( ) const

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

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

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

bool casa::PMS_PP_Axes::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 656 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Axes::resize	(	int	count,
		bool	copyValues = `False`
	)

Change the size of the vectors.

void casa::PMS_PP_Axes::setAxes	(	const PlotAxis &	xAxis,
		const PlotAxis &	yAxis,
		unsigned int	index = `0`
	)

Sets single versions of the parameters for the given index.

void casa::PMS_PP_Axes::setDefaults ( )

private

void casa::PMS_PP_Axes::setRanges	(	const bool &	xSet,
		const bool &	ySet,
		const prange_t &	xRange,
		const prange_t &	yRange,
		unsigned int	index = `0`
	)

Referenced by setXRange(), and setYRange().

void casa::PMS_PP_Axes::setXAxes ( const vector< PlotAxis > & value )

inline

Definition at line 698 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXAxis	(	const PlotAxis &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 711 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRange	(	const bool &	set,
		const prange_t &	range,
		unsigned int	index = `0`
	)

inline

Definition at line 681 of file PlotMSPlotParameterGroups.h.

References setRanges(), yRange(), and yRangeSet().

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

inline

Definition at line 775 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRange	(	const prange_t &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 826 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRanges ( const vector< bool > & value )

inline

Definition at line 762 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRanges ( const vector< prange_t > & value )

inline

Definition at line 815 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYAxes ( const vector< PlotAxis > & value )

inline

Definition at line 727 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYAxis	(	const PlotAxis &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 740 of file PlotMSPlotParameterGroups.h.

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

Referenced by setYAxis().

void casa::PMS_PP_Axes::setYAxis	(	casacore::String &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 749 of file PlotMSPlotParameterGroups.h.

References setYAxis(), casa::Y_LEFT, and casa::Y_RIGHT.

void casa::PMS_PP_Axes::setYRange	(	const bool &	set,
		const prange_t &	range,
		unsigned int	index = `0`
	)

inline

Definition at line 685 of file PlotMSPlotParameterGroups.h.

References setRanges(), xRange(), and xRangeSet().

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

inline

Definition at line 801 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYRange	(	const prange_t &	value,
		unsigned int	index = `0`
	)

inline

Definition at line 848 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYRanges ( const vector< bool > & value )

inline

Definition at line 788 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYRanges ( const vector< prange_t > & value )

inline

Definition at line 837 of file PlotMSPlotParameterGroups.h.

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

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

virtual

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

Implements casa::PlotMSPlotParameters::Group.

const vector< PlotAxis >& casa::PMS_PP_Axes::xAxes ( ) const

inline

Definition at line 695 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

PlotAxis casa::PMS_PP_Axes::xAxis ( unsigned int index = 0 ) const

inline

Definition at line 706 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

const prange_t& casa::PMS_PP_Axes::xRange ( unsigned int index = 0 ) const

inline

Definition at line 823 of file PlotMSPlotParameterGroups.h.

References itsXRanges_.

Referenced by setYRange().

const vector< prange_t >& casa::PMS_PP_Axes::xRanges ( ) const

inline

Definition at line 812 of file PlotMSPlotParameterGroups.h.

References itsXRanges_.

bool casa::PMS_PP_Axes::xRangeSet ( unsigned int index = 0 ) const

inline

Definition at line 770 of file PlotMSPlotParameterGroups.h.

References itsXRangesSet_.

Referenced by setYRange().

const std::vector<bool>& casa::PMS_PP_Axes::xRangesSet ( ) const

inline

Definition at line 759 of file PlotMSPlotParameterGroups.h.

References itsXRangesSet_.

const std::vector<PlotAxis>& casa::PMS_PP_Axes::yAxes ( ) const

inline

Definition at line 724 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

PlotAxis casa::PMS_PP_Axes::yAxis ( unsigned int index = 0 ) const

inline

Definition at line 735 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

const prange_t& casa::PMS_PP_Axes::yRange ( unsigned int index = 0 ) const

inline

Definition at line 845 of file PlotMSPlotParameterGroups.h.

References itsYRanges_.

Referenced by setXRange().

const vector< prange_t >& casa::PMS_PP_Axes::yRanges ( ) const

inline

Definition at line 834 of file PlotMSPlotParameterGroups.h.

References itsYRanges_.

bool casa::PMS_PP_Axes::yRangeSet ( unsigned int index = 0 ) const

inline

Definition at line 796 of file PlotMSPlotParameterGroups.h.

References itsYRangesSet_.

Referenced by setXRange().

const vector< bool >& casa::PMS_PP_Axes::yRangesSet ( ) const

inline

Definition at line 785 of file PlotMSPlotParameterGroups.h.

References itsYRangesSet_.

Member Data Documentation

std::vector<PlotAxis> casa::PMS_PP_Axes::itsXAxes_

private

Definition at line 864 of file PlotMSPlotParameterGroups.h.

Referenced by setXAxes(), setXAxis(), xAxes(), and xAxis().

std::vector<prange_t> casa::PMS_PP_Axes::itsXRanges_

private

Definition at line 868 of file PlotMSPlotParameterGroups.h.

Referenced by setXRange(), setXRanges(), xRange(), and xRanges().

std::vector<bool> casa::PMS_PP_Axes::itsXRangesSet_

private

Definition at line 866 of file PlotMSPlotParameterGroups.h.

Referenced by setXRange(), setXRanges(), xRangeSet(), and xRangesSet().

std::vector<PlotAxis> casa::PMS_PP_Axes::itsYAxes_

private

Definition at line 865 of file PlotMSPlotParameterGroups.h.

Referenced by setYAxes(), setYAxis(), yAxes(), and yAxis().

std::vector<prange_t> casa::PMS_PP_Axes::itsYRanges_

private

Definition at line 869 of file PlotMSPlotParameterGroups.h.

Referenced by setYRange(), setYRanges(), yRange(), and yRanges().

std::vector<bool> casa::PMS_PP_Axes::itsYRangesSet_

private

Definition at line 867 of file PlotMSPlotParameterGroups.h.

Referenced by setYRange(), setYRanges(), yRangeSet(), and yRangesSet().

const casacore::String casa::PMS_PP_Axes::REC_XAXES

staticprivate

Definition at line 872 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Axes::REC_XRANGES

staticprivate

Definition at line 876 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Axes::REC_XRANGESSET

staticprivate

Definition at line 874 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Axes::REC_YAXES

staticprivate

Definition at line 873 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Axes::REC_YRANGES

staticprivate

Definition at line 877 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Axes::REC_YRANGESSET

staticprivate

Definition at line 875 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