casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
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:
casa::PlotMSPlotParameters::Group

Public Member Functions

 PMS_PP_Cache (PlotFactoryPtr factory)
 
 PMS_PP_Cache (const PMS_PP_Cache &copy)
 
 ~PMS_PP_Cache ()
 
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_Cache & operator= (const PMS_PP_Cache &other)
 
PMS_PP_Cache & operator= (const Group &other)
 
bool operator== (const Group &other) const
 
unsigned int numXAxes () const
 Gets how many axes and data columns there are. More...
 
unsigned int numYAxes () const
 
void setXAxis (const PMS::Axis &axis, const PMS::DataColumn &data, unsigned int index=0)
 Setting the data and data columns for the x- and y-axes. More...
 
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 std::vector< PMS::Axis > & xAxes () const
 
void setXAxes (const std::vector< PMS::Axis > &value)
 
PMS::Axis xAxis (unsigned int index=0) const
 
void setXAxis (const PMS::Axis &value, unsigned int index=0)
 
const std::vector< PMS::Axis > & yAxes () const
 
void setYAxes (const std::vector< PMS::Axis > &value)
 
PMS::Axis yAxis (unsigned int index=0) const
 
void setYAxis (const PMS::Axis &value, unsigned int index=0)
 
const std::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)
 
const vector< PMS::CoordSystem > & xFrames () const
 
void setXFrames (const vector< PMS::CoordSystem > &value)
 
PMS::CoordSystem xFrame (unsigned int index=0) const
 
void setXFrame (const PMS::CoordSystem &value, unsigned int index=0)
 
const vector< PMS::CoordSystem > & yFrames () const
 
void setYFrames (const vector< PMS::CoordSystem > &value)
 
PMS::CoordSystem yFrame (unsigned int index=0) const
 
void setYFrame (const PMS::CoordSystem &value, unsigned int index=0)
 
const vector< PMS::InterpMethod > & xInterps () const
 
void setXInterps (const vector< PMS::InterpMethod > &value)
 
PMS::InterpMethod xInterp (unsigned int index=0) const
 
void setXInterp (const PMS::InterpMethod &value, unsigned int index=0)
 
const vector< PMS::InterpMethod > & yInterps () const
 
void setYInterps (const vector< PMS::InterpMethod > &value)
 
PMS::InterpMethod yInterp (unsigned int index=0) const
 
void setYInterp (const PMS::InterpMethod &value, unsigned int index=0)
 
DirectionAxisParams xDirectionParams (unsigned int index=0) const
 
DirectionAxisParams yDirectionParams (unsigned int index=0) const
 
bool showAtm () const
 
void setShowAtm (const bool &value)
 
bool showTsky () const
 
void setShowTsky (const bool &value)
 
bool showImage () const
 
void setShowImage (const bool &value)
 
void resize (int count)
 
- 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_Cache & assign (const PMS_PP_Cache *o)
 Does the work for the operator=()s. More...
 
void setDefaults ()
 

Private Attributes

std::vector< PMS::Axis > itsXAxes_
 
std::vector< PMS::Axis > itsYAxes_
 
std::vector< PMS::DataColumn > itsXData_
 
std::vector< PMS::DataColumn > itsYData_
 
std::vector< PMS::CoordSystem > itsXFrame_
 
std::vector< PMS::InterpMethod > itsXInterp_
 
std::vector< PMS::CoordSystem > itsYFrame_
 
std::vector< PMS::InterpMethod > itsYInterp_
 
bool itsShowAtm_
 
bool itsShowTsky_
 
bool itsShowImage_
 

Static Private Attributes

static const casacore::String REC_XAXES
 
static const casacore::String REC_YAXES
 
static const casacore::String REC_XDATACOLS
 
static const casacore::String REC_YDATACOLS
 
static const casacore::String REC_XFRAMES
 
static const casacore::String REC_YFRAMES
 
static const casacore::String REC_XINTERPS
 
static const casacore::String REC_YINTERPS
 
static const casacore::String REC_SHOWATM
 
static const casacore::String REC_SHOWTSKY
 
static const casacore::String REC_SHOWIMAGE
 

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 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 280 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

PMS_PP_Cache& casa::PMS_PP_Cache::assign ( const PMS_PP_Cache *  o)
private

Does the work for the operator=()s.

Group* casa::PMS_PP_Cache::clone ( ) const
inlinevirtual

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 292 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Cache().

void casa::PMS_PP_Cache::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_Cache::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 297 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
PMS_PP_Cache& casa::PMS_PP_Cache::operator= ( const PMS_PP_Cache &  other)
PMS_PP_Cache& 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
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 309 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Cache::resize ( int  count)
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 
)
void casa::PMS_PP_Cache::setDefaults ( )
private
void casa::PMS_PP_Cache::setShowAtm ( const bool &  value)
inline

Definition at line 556 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setShowImage ( const bool &  value)
inline

Definition at line 576 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setShowTsky ( const bool &  value)
inline

Definition at line 566 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXAxes ( const std::vector< PMS::Axis > &  value)
inline

Definition at line 343 of file PlotMSPlotParameterGroups.h.

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

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

Setting the data and data columns for the x- and y-axes.

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

Definition at line 354 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 404 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXDataColumns ( const vector< PMS::DataColumn > &  value)
inline

Definition at line 392 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXFrame ( const PMS::CoordSystem &  value,
unsigned int  index = 0 
)
inline

Definition at line 456 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXFrames ( const vector< PMS::CoordSystem > &  value)
inline

Definition at line 444 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXInterp ( const PMS::InterpMethod &  value,
unsigned int  index = 0 
)
inline

Definition at line 509 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setXInterps ( const vector< PMS::InterpMethod > &  value)
inline

Definition at line 497 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYAxes ( const std::vector< PMS::Axis > &  value)
inline

Definition at line 367 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 378 of file PlotMSPlotParameterGroups.h.

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

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

Definition at line 430 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYDataColumns ( const vector< PMS::DataColumn > &  value)
inline

Definition at line 418 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYFrame ( const PMS::CoordSystem &  value,
unsigned int  index = 0 
)
inline

Definition at line 483 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYFrames ( const vector< PMS::CoordSystem > &  value)
inline

Definition at line 470 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYInterp ( const PMS::InterpMethod &  value,
unsigned int  index = 0 
)
inline

Definition at line 535 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Cache::setYInterps ( const vector< PMS::InterpMethod > &  value)
inline

Definition at line 523 of file PlotMSPlotParameterGroups.h.

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

bool casa::PMS_PP_Cache::showAtm ( ) const
inline

Definition at line 553 of file PlotMSPlotParameterGroups.h.

References itsShowAtm_.

bool casa::PMS_PP_Cache::showImage ( ) const
inline

Definition at line 573 of file PlotMSPlotParameterGroups.h.

References itsShowImage_.

bool casa::PMS_PP_Cache::showTsky ( ) const
inline

Definition at line 563 of file PlotMSPlotParameterGroups.h.

References itsShowTsky_.

casacore::Record casa::PMS_PP_Cache::toRecord ( ) const
virtual

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

Implements casa::PlotMSPlotParameters::Group.

const std::vector<PMS::Axis>& casa::PMS_PP_Cache::xAxes ( ) const
inline

Definition at line 340 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

PMS::Axis casa::PMS_PP_Cache::xAxis ( unsigned int  index = 0) const
inline

Definition at line 349 of file PlotMSPlotParameterGroups.h.

References itsXAxes_.

PMS::DataColumn casa::PMS_PP_Cache::xDataColumn ( unsigned int  index = 0) const
inline

Definition at line 398 of file PlotMSPlotParameterGroups.h.

References itsXData_.

const std::vector<PMS::DataColumn>& casa::PMS_PP_Cache::xDataColumns ( ) const
inline

Definition at line 389 of file PlotMSPlotParameterGroups.h.

References itsXData_.

DirectionAxisParams casa::PMS_PP_Cache::xDirectionParams ( unsigned int  index = 0) const
inline

Definition at line 545 of file PlotMSPlotParameterGroups.h.

References xFrame(), and xInterp().

PMS::CoordSystem casa::PMS_PP_Cache::xFrame ( unsigned int  index = 0) const
inline

Definition at line 450 of file PlotMSPlotParameterGroups.h.

References itsXFrame_.

Referenced by xDirectionParams().

const vector< PMS::CoordSystem >& casa::PMS_PP_Cache::xFrames ( ) const
inline

Definition at line 441 of file PlotMSPlotParameterGroups.h.

References itsXFrame_.

PMS::InterpMethod casa::PMS_PP_Cache::xInterp ( unsigned int  index = 0) const
inline

Definition at line 503 of file PlotMSPlotParameterGroups.h.

References itsXInterp_.

Referenced by xDirectionParams().

const vector< PMS::InterpMethod >& casa::PMS_PP_Cache::xInterps ( ) const
inline

Definition at line 494 of file PlotMSPlotParameterGroups.h.

References itsXInterp_.

const std::vector<PMS::Axis>& casa::PMS_PP_Cache::yAxes ( ) const
inline

Definition at line 364 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

PMS::Axis casa::PMS_PP_Cache::yAxis ( unsigned int  index = 0) const
inline

Definition at line 373 of file PlotMSPlotParameterGroups.h.

References itsYAxes_.

PMS::DataColumn casa::PMS_PP_Cache::yDataColumn ( unsigned int  index = 0) const
inline

Definition at line 424 of file PlotMSPlotParameterGroups.h.

References itsYData_.

const vector< PMS::DataColumn >& casa::PMS_PP_Cache::yDataColumns ( ) const
inline

Definition at line 415 of file PlotMSPlotParameterGroups.h.

References itsYData_.

DirectionAxisParams casa::PMS_PP_Cache::yDirectionParams ( unsigned int  index = 0) const
inline

Definition at line 548 of file PlotMSPlotParameterGroups.h.

References yFrame(), and yInterp().

PMS::CoordSystem casa::PMS_PP_Cache::yFrame ( unsigned int  index = 0) const
inline

Definition at line 476 of file PlotMSPlotParameterGroups.h.

References itsYFrame_.

Referenced by yDirectionParams().

const vector< PMS::CoordSystem >& casa::PMS_PP_Cache::yFrames ( ) const
inline

Definition at line 467 of file PlotMSPlotParameterGroups.h.

References itsYFrame_.

PMS::InterpMethod casa::PMS_PP_Cache::yInterp ( unsigned int  index = 0) const
inline

Definition at line 529 of file PlotMSPlotParameterGroups.h.

References itsYInterp_.

Referenced by yDirectionParams().

const vector< PMS::InterpMethod >& casa::PMS_PP_Cache::yInterps ( ) const
inline

Definition at line 520 of file PlotMSPlotParameterGroups.h.

References itsYInterp_.

Member Data Documentation

bool casa::PMS_PP_Cache::itsShowAtm_
private

Definition at line 598 of file PlotMSPlotParameterGroups.h.

Referenced by setShowAtm(), and showAtm().

bool casa::PMS_PP_Cache::itsShowImage_
private

Definition at line 600 of file PlotMSPlotParameterGroups.h.

Referenced by setShowImage(), and showImage().

bool casa::PMS_PP_Cache::itsShowTsky_
private

Definition at line 599 of file PlotMSPlotParameterGroups.h.

Referenced by setShowTsky(), and showTsky().

std::vector<PMS::Axis> casa::PMS_PP_Cache::itsXAxes_
private

Definition at line 589 of file PlotMSPlotParameterGroups.h.

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

std::vector<PMS::DataColumn> casa::PMS_PP_Cache::itsXData_
private

Definition at line 591 of file PlotMSPlotParameterGroups.h.

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

std::vector<PMS::CoordSystem> casa::PMS_PP_Cache::itsXFrame_
private

Definition at line 593 of file PlotMSPlotParameterGroups.h.

Referenced by setXFrame(), setXFrames(), xFrame(), and xFrames().

std::vector<PMS::InterpMethod> casa::PMS_PP_Cache::itsXInterp_
private

Definition at line 594 of file PlotMSPlotParameterGroups.h.

Referenced by setXInterp(), setXInterps(), xInterp(), and xInterps().

std::vector<PMS::Axis> casa::PMS_PP_Cache::itsYAxes_
private

Definition at line 590 of file PlotMSPlotParameterGroups.h.

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

std::vector<PMS::DataColumn> casa::PMS_PP_Cache::itsYData_
private

Definition at line 592 of file PlotMSPlotParameterGroups.h.

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

std::vector<PMS::CoordSystem> casa::PMS_PP_Cache::itsYFrame_
private

Definition at line 595 of file PlotMSPlotParameterGroups.h.

Referenced by setYFrame(), setYFrames(), yFrame(), and yFrames().

std::vector<PMS::InterpMethod> casa::PMS_PP_Cache::itsYInterp_
private

Definition at line 596 of file PlotMSPlotParameterGroups.h.

Referenced by setYInterp(), setYInterps(), yInterp(), and yInterps().

const casacore::String casa::PMS_PP_Cache::REC_SHOWATM
staticprivate

Definition at line 612 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_SHOWIMAGE
staticprivate

Definition at line 614 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_SHOWTSKY
staticprivate

Definition at line 613 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_XAXES
staticprivate

Definition at line 604 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_XDATACOLS
staticprivate

Definition at line 606 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_XFRAMES
staticprivate

Definition at line 608 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_XINTERPS
staticprivate

Definition at line 610 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_YAXES
staticprivate

Definition at line 605 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_YDATACOLS
staticprivate

Definition at line 607 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_YFRAMES
staticprivate

Definition at line 609 of file PlotMSPlotParameterGroups.h.

const casacore::String casa::PMS_PP_Cache::REC_YINTERPS
staticprivate

Definition at line 611 of file PlotMSPlotParameterGroups.h.

The documentation for this class was generated from the following file:
Generated on Sun Sep 1 2019 23:33:22 for casa by   doxygen 1.8.5