casa::PMS_PP_Cache Class Reference

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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Cache:

List of all members.

Public Member Functions
	PMS_PP_Cache (PlotFactoryPtr factory)
	PMS_PP_Cache (const PMS_PP_Cache &copy)
	~PMS_PP_Cache ()
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.
Group &	operator= (const Group &other)
bool	operator== (const Group &other) const
unsigned int	numXAxes () const
	Gets how many axes and data columns there are.
unsigned int	numYAxes () const
void	setXAxis (const PMS::Axis &axis, const PMS::DataColumn &data, unsigned int index=0)
void	setYAxis (const PMS::Axis &axis, const PMS::DataColumn &data, unsigned int index=0)
void	setAxes (const PMS::Axis &xAxis, const PMS::Axis &yAxis, const PMS::DataColumn &xData, const PMS::DataColumn &yData, unsigned int index=0)
const vector< PMS::Axis > &	xAxes () const
void	setXAxes (const vector< PMS::Axis > &value)
PMS::Axis	xAxis (unsigned int index=0) const
void	setXAxis (const PMS::Axis &value, unsigned int index=0)
const vector< PMS::Axis > &	yAxes () const
void	setYAxes (const vector< PMS::Axis > &value)
PMS::Axis	yAxis (unsigned int index=0) const
void	setYAxis (const PMS::Axis &value, unsigned int index=0)
const vector< PMS::DataColumn > &	xDataColumns () const
void	setXDataColumns (const vector< PMS::DataColumn > &value)
PMS::DataColumn	xDataColumn (unsigned int index=0) const
void	setXDataColumn (const PMS::DataColumn &value, unsigned int index=0)
const vector< PMS::DataColumn > &	yDataColumns () const
void	setYDataColumns (const vector< PMS::DataColumn > &value)
PMS::DataColumn	yDataColumn (unsigned int index=0) const
void	setYDataColumn (const PMS::DataColumn &value, unsigned int index=0)
Private Member Functions
void	setDefaults ()
Private Attributes
vector< PMS::Axis >	itsXAxes_
vector< PMS::Axis >	itsYAxes_
vector< PMS::DataColumn >	itsXData_
vector< PMS::DataColumn >	itsYData_
Static Private Attributes
static const String	REC_XAXES
static const String	REC_YAXES
static const String	REC_XDATACOLS
static const String	REC_YDATACOLS

---

Detailed Description

Subclass of PlotMSPlotParameters::Group to handle cache parameters.

Currently includes: x and y axes x and y data columns Parameters are vector-based, on a per-plot basis.

Definition at line 230 of file PlotMSPlotParameterGroups.h.

---

Constructor & Destructor Documentation

casa::PMS_PP_Cache::PMS_PP_Cache

(

PlotFactoryPtr

factory

)

Referenced by clone().

casa::PMS_PP_Cache::PMS_PP_Cache

(

const PMS_PP_Cache &

copy

)

casa::PMS_PP_Cache::~PMS_PP_Cache

(

)

---

Member Function Documentation

Group* casa::PMS_PP_Cache::clone

(

)

const [inline, virtual]

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 242 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Cache().

void casa::PMS_PP_Cache::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_Cache::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 247 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_CACHE_NAME.

unsigned int casa::PMS_PP_Cache::numXAxes

(

)

const

Gets how many axes and data columns there are.

unsigned int casa::PMS_PP_Cache::numYAxes

(

)

const

Group& casa::PMS_PP_Cache::operator=

(

const Group &

other

)

bool casa::PMS_PP_Cache::operator==

(

const Group &

other

)

const

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

void casa::PMS_PP_Cache::setAxes	(	const PMS::Axis &	xAxis,
		const PMS::Axis &	yAxis,
		const PMS::DataColumn &	xData,
		const PMS::DataColumn &	yData,
		unsigned int	index = 0
	)

Referenced by setXAxis(), and setYAxis().

void casa::PMS_PP_Cache::setDefaults

(

)

[private]

void casa::PMS_PP_Cache::setXAxes

(

const vector< PMS::Axis > &

value

)

[inline]

Definition at line 294 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXAxis	(	const PMS::Axis &	axis,
		const PMS::DataColumn &	data,
		unsigned int	index = 0
	)		[inline]

Definition at line 278 of file PlotMSPlotParameterGroups.h.

References setAxes(), yAxis(), and yDataColumn().

void casa::PMS_PP_Cache::setXAxis	(	const PMS::Axis &	value,
		unsigned int	index = 0
	)		[inline]

Definition at line 305 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXDataColumn	(	const PMS::DataColumn &	value,
		unsigned int	index = 0
	)		[inline]

Definition at line 354 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXDataColumns

(

const vector< PMS::DataColumn > &

value

)

[inline]

Definition at line 342 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYAxes

(

const vector< PMS::Axis > &

value

)

[inline]

Definition at line 318 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYAxis	(	const PMS::Axis &	axis,
		const PMS::DataColumn &	data,
		unsigned int	index = 0
	)		[inline]

Definition at line 282 of file PlotMSPlotParameterGroups.h.

References setAxes(), xAxis(), and xDataColumn().

void casa::PMS_PP_Cache::setYAxis	(	const PMS::Axis &	value,
		unsigned int	index = 0
	)		[inline]

Definition at line 329 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYDataColumn	(	const PMS::DataColumn &	value,
		unsigned int	index = 0
	)		[inline]

Definition at line 380 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYDataColumns

(

const vector< PMS::DataColumn > &

value

)

[inline]

Definition at line 368 of file PlotMSPlotParameterGroups.h.

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

Record casa::PMS_PP_Cache::toRecord

(

)

const [virtual]

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

const vector<PMS::Axis>& casa::PMS_PP_Cache::xAxes

(

)

const [inline]

Definition at line 291 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

PMS::Axis casa::PMS_PP_Cache::xAxis

(

unsigned int

index = 0

)

const [inline]

Definition at line 300 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

Referenced by setYAxis().

PMS::DataColumn casa::PMS_PP_Cache::xDataColumn

(

unsigned int

index = 0

)

const [inline]

Definition at line 348 of file PlotMSPlotParameterGroups.h.

References itsXData_.

Referenced by setYAxis().

const vector<PMS::DataColumn>& casa::PMS_PP_Cache::xDataColumns

(

)

const [inline]

Definition at line 339 of file PlotMSPlotParameterGroups.h.

References itsXData_.

const vector<PMS::Axis>& casa::PMS_PP_Cache::yAxes

(

)

const [inline]

Definition at line 315 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

PMS::Axis casa::PMS_PP_Cache::yAxis

(

unsigned int

index = 0

)

const [inline]

Definition at line 324 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

Referenced by setXAxis().

PMS::DataColumn casa::PMS_PP_Cache::yDataColumn

(

unsigned int

index = 0

)

const [inline]

Definition at line 374 of file PlotMSPlotParameterGroups.h.

References itsYData_.

Referenced by setXAxis().

const vector< PMS::DataColumn >& casa::PMS_PP_Cache::yDataColumns

(

)

const [inline]

Definition at line 365 of file PlotMSPlotParameterGroups.h.

References itsYData_.

---

Member Data Documentation

vector<PMS::Axis> casa::PMS_PP_Cache::itsXAxes_ [private]

Definition at line 393 of file PlotMSPlotParameterGroups.h.

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

vector<PMS::DataColumn> casa::PMS_PP_Cache::itsXData_ [private]

Definition at line 395 of file PlotMSPlotParameterGroups.h.

Referenced by setXDataColumn(), setXDataColumns(), xDataColumn(), and xDataColumns().

vector<PMS::Axis> casa::PMS_PP_Cache::itsYAxes_ [private]

Definition at line 394 of file PlotMSPlotParameterGroups.h.

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

vector<PMS::DataColumn> casa::PMS_PP_Cache::itsYData_ [private]

Definition at line 396 of file PlotMSPlotParameterGroups.h.

Referenced by setYDataColumn(), setYDataColumns(), yDataColumn(), and yDataColumns().

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

Definition at line 399 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Cache::REC_XDATACOLS [static, private]

Definition at line 401 of file PlotMSPlotParameterGroups.h.

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

Definition at line 400 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Cache::REC_YDATACOLS [static, private]

Definition at line 402 of file PlotMSPlotParameterGroups.h.

---

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

• code/plotms/Plots/PlotMSPlotParameterGroups.h