casa::PMS_PP_Axes Class Reference

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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Axes:

List of all members.

Public Member Functions
	PMS_PP_Axes (PlotFactoryPtr factory)
	PMS_PP_Axes (const PMS_PP_Axes &copy)
	~PMS_PP_Axes ()
Group *	clone () const
	Abstract Methods //.
const String &	name () const
	Returns the name of this group of subparameters.
Record	toRecord () const
	Returns a Record representing this group of subparameters.
void	fromRecord (const Record &record)
	Sets the values for this group of subparameters using the given Record.
bool	requiresRedrawOnChange () const
	Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise.
PMS_PP_Axes &	operator= (const PMS_PP_Axes &other)
	Implemented Methods //.
PMS_PP_Axes &	operator= (const Group &other)
bool	operator== (const Group &other) const
unsigned int	numXAxes () const
	Gets how many axes there are.
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.
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 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 (String &value, unsigned int index=0)
const 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)
	Change the size of the vectors.
Private Member Functions
PMS_PP_Axes &	assign (const PMS_PP_Axes *o)
	Does the work for operator=()s.
void	setDefaults ()
Private Attributes
vector< PlotAxis >	itsXAxes_
vector< PlotAxis >	itsYAxes_
vector< bool >	itsXRangesSet_
vector< bool >	itsYRangesSet_
vector< prange_t >	itsXRanges_
vector< prange_t >	itsYRanges_
Static Private Attributes
static const String	REC_XAXES
static const String	REC_YAXES
static const String	REC_XRANGESSET
static const String	REC_YRANGESSET
static const String	REC_XRANGES
static const String	REC_YRANGES

---

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 443 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 [inline, virtual]

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 456 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Axes().

void casa::PMS_PP_Axes::fromRecord

(

const Record &

record

)

[virtual]

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

Implements casa::PlotMSPlotParameters::Group.

const String& casa::PMS_PP_Axes::name

(

)

const [inline, virtual]

Returns the name of this group of subparameters.

Will be used as an update flag.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 461 of file PlotMSPlotParameterGroups.h.

References String, and 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 Group &

other

)

PMS_PP_Axes& casa::PMS_PP_Axes::operator=

(

const PMS_PP_Axes &

other

)

[virtual]

Implemented Methods //.

Copy operator. Should probably be overridden by children to be more efficient. Only copies if the two groups have the same name.

Reimplemented from casa::PlotMSPlotParameters::Group.

bool casa::PMS_PP_Axes::operator==

(

const Group &

other

)

const

bool casa::PMS_PP_Axes::requiresRedrawOnChange

(

)

const [inline, virtual]

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 473 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Axes::resize

(

int

count

)

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 515 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 528 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 643 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 592 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 498 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRanges

(

const vector< prange_t > &

value

)

[inline]

Definition at line 632 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setXRanges

(

const vector< bool > &

value

)

[inline]

Definition at line 579 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYAxes

(

const vector< PlotAxis > &

value

)

[inline]

Definition at line 544 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYAxis	(	String &	value,
		unsigned int	index = 0
	)			[inline]

Definition at line 566 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 557 of file PlotMSPlotParameterGroups.h.

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

Referenced by setYAxis().

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

Definition at line 665 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 618 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 502 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYRanges

(

const vector< prange_t > &

value

)

[inline]

Definition at line 654 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Axes::setYRanges

(

const vector< bool > &

value

)

[inline]

Definition at line 605 of file PlotMSPlotParameterGroups.h.

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

Record casa::PMS_PP_Axes::toRecord

(

)

const [virtual]

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

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

(

)

const [inline]

Definition at line 512 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

PlotAxis casa::PMS_PP_Axes::xAxis

(

unsigned int

index = 0

)

const [inline]

Definition at line 523 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

const prange_t& casa::PMS_PP_Axes::xRange

(

unsigned int

index = 0

)

const [inline]

Definition at line 640 of file PlotMSPlotParameterGroups.h.

References itsXRanges_.

Referenced by setYRange().

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

(

)

const [inline]

Definition at line 629 of file PlotMSPlotParameterGroups.h.

References itsXRanges_.

bool casa::PMS_PP_Axes::xRangeSet

(

unsigned int

index = 0

)

const [inline]

Definition at line 587 of file PlotMSPlotParameterGroups.h.

References itsXRangesSet_.

Referenced by setYRange().

const vector<bool>& casa::PMS_PP_Axes::xRangesSet

(

)

const [inline]

Definition at line 576 of file PlotMSPlotParameterGroups.h.

References itsXRangesSet_.

const vector<PlotAxis>& casa::PMS_PP_Axes::yAxes

(

)

const [inline]

Definition at line 541 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

PlotAxis casa::PMS_PP_Axes::yAxis

(

unsigned int

index = 0

)

const [inline]

Definition at line 552 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

const prange_t& casa::PMS_PP_Axes::yRange

(

unsigned int

index = 0

)

const [inline]

Definition at line 662 of file PlotMSPlotParameterGroups.h.

References itsYRanges_.

Referenced by setXRange().

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

(

)

const [inline]

Definition at line 651 of file PlotMSPlotParameterGroups.h.

References itsYRanges_.

bool casa::PMS_PP_Axes::yRangeSet

(

unsigned int

index = 0

)

const [inline]

Definition at line 613 of file PlotMSPlotParameterGroups.h.

References itsYRangesSet_.

Referenced by setXRange().

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

(

)

const [inline]

Definition at line 602 of file PlotMSPlotParameterGroups.h.

References itsYRangesSet_.

---

Member Data Documentation

vector<PlotAxis> casa::PMS_PP_Axes::itsXAxes_ [private]

Definition at line 681 of file PlotMSPlotParameterGroups.h.

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

vector<prange_t> casa::PMS_PP_Axes::itsXRanges_ [private]

Definition at line 685 of file PlotMSPlotParameterGroups.h.

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

vector<bool> casa::PMS_PP_Axes::itsXRangesSet_ [private]

Definition at line 683 of file PlotMSPlotParameterGroups.h.

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

vector<PlotAxis> casa::PMS_PP_Axes::itsYAxes_ [private]

Definition at line 682 of file PlotMSPlotParameterGroups.h.

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

vector<prange_t> casa::PMS_PP_Axes::itsYRanges_ [private]

Definition at line 686 of file PlotMSPlotParameterGroups.h.

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

vector<bool> casa::PMS_PP_Axes::itsYRangesSet_ [private]

Definition at line 684 of file PlotMSPlotParameterGroups.h.

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

const String casa::PMS_PP_Axes::REC_XAXES [static, private]

Definition at line 689 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Axes::REC_XRANGES [static, private]

Definition at line 693 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Axes::REC_XRANGESSET [static, private]

Definition at line 691 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Axes::REC_YAXES [static, private]

Definition at line 690 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Axes::REC_YRANGES [static, private]

Definition at line 694 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Axes::REC_YRANGESSET [static, private]

Definition at line 692 of file PlotMSPlotParameterGroups.h.

---

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

• code/plotms/Plots/PlotMSPlotParameterGroups.h