casa::PMS_PP_PageHeader Class Reference

Subclass of PlotMSPlotParameters::Group to handle page header parameters. More...

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_PageHeader:

Public Member Functions
	PMS_PP_PageHeader (PlotFactoryPtr factory)
	PMS_PP_PageHeader (const PMS_PP_PageHeader &copy)
	~PMS_PP_PageHeader ()
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...
PMS_PP_PageHeader &	operator= (const Group &other)
PMS_PP_PageHeader &	operator= (const PMS_PP_PageHeader &other)
bool	operator== (const Group &other) const
bool	requiresRedrawOnChange () const
	Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise. More...
void	setPageHeaderItems (const PageHeaderItems &value)
const PageHeaderItems &	pageHeaderItems () const
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_PageHeader &	assign (const PMS_PP_PageHeader *o)
	Does the work for the operator=()s. More...
void	setDefaults ()

Private Attributes
PageHeaderItems	itsPageHeaderItems_

Static Private Attributes
static const casacore::String	REC_ITEMS

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 page header parameters.

Currently includes: page header items

Parameters are vector-based, on a per-plot basis.

Definition at line 1639 of file PlotMSPlotParameterGroups.h.

Constructor & Destructor Documentation

casa::PMS_PP_PageHeader::PMS_PP_PageHeader

(

PlotFactoryPtr

factory

)

Referenced by clone().

casa::PMS_PP_PageHeader::PMS_PP_PageHeader

(

const PMS_PP_PageHeader &

copy

)

casa::PMS_PP_PageHeader::~PMS_PP_PageHeader

(

)

Member Function Documentation

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

private

Does the work for the operator=()s.

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

inlinevirtual

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1651 of file PlotMSPlotParameterGroups.h.

References PMS_PP_PageHeader().

void casa::PMS_PP_PageHeader::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_PageHeader::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 1656 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_PAGEHEADER_NAME.

PMS_PP_PageHeader& casa::PMS_PP_PageHeader::operator=

(

const Group &

other

)

PMS_PP_PageHeader& casa::PMS_PP_PageHeader::operator=

(

const PMS_PP_PageHeader &

other

)

bool casa::PMS_PP_PageHeader::operator==

(

const Group &

other

)

const

const PageHeaderItems& casa::PMS_PP_PageHeader::pageHeaderItems ( ) const

inline

Definition at line 1688 of file PlotMSPlotParameterGroups.h.

References itsPageHeaderItems_.

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

void casa::PMS_PP_PageHeader::setDefaults ( )

private

void casa::PMS_PP_PageHeader::setPageHeaderItems ( const PageHeaderItems &  value )

inline

Definition at line 1681 of file PlotMSPlotParameterGroups.h.

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

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

virtual

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

Implements casa::PlotMSPlotParameters::Group.

Member Data Documentation

PageHeaderItems casa::PMS_PP_PageHeader::itsPageHeaderItems_

private

Definition at line 1692 of file PlotMSPlotParameterGroups.h.

Referenced by pageHeaderItems(), and setPageHeaderItems().

const casacore::String casa::PMS_PP_PageHeader::REC_ITEMS

staticprivate

Definition at line 1695 of file PlotMSPlotParameterGroups.h.

---

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

• casa/code/plotms/Plots/PlotMSPlotParameterGroups.h