#include <PlotMSPlotParameters.h>

Inheritance diagram for casa::PlotMSPlotParameters:

Classes
class	Group
	Static //. More...
Public Member Functions
	PlotMSPlotParameters (PlotFactoryPtr factory)
	Non-Static //.
	PlotMSPlotParameters (const PlotMSPlotParameters &copy)
	Copy constructor.
	~PlotMSPlotParameters ()
	Destructor.
bool	equals (const PlotMSWatchedParameters &other, int updateFlags) const
	Implements PlotMSWatchedParameters::equals().
const Group *	group (const String &name) const
	Returns the subparameters group with the given name, or NULL for none.
Group *	group (const String &name)
template<class T >
const T *	typedGroup () const
	Returns the templated type of subparameters group, or NULL for none.
template<class T >
T *	typedGroup ()
void	setGroup (const Group &group)
	Sets (or adds) the given group of subparameters in this object, cloning it.
template<class T >
void	setGroup ()
	Sets (or adds) the default constructor of the templated type of subparameters group.
PlotMSPlotParameters &	operator= (const PlotMSPlotParameters &copy)
	Copy operator.
Protected Member Functions
void	notifyWatchers (int updateFlags, PlotMSParametersWatcher *updater=NULL)
	Notifies any watchers that the parameters have been updated with the given flags.
void	notifyWatchers (const String &updateName, PlotMSParametersWatcher *updater=NULL)
Protected Attributes
PlotFactoryPtr	itsFactory_
	Factory.
Private Member Functions
void	groupUpdated (Group *group, bool requiresRedraw)
	To be called when one of the groups is updated.
Private Attributes
vector< Group * >	itsGroups_

Friends
class	PlotMSPlotParameters::Group

Detailed Description

Parameters for a PlotMSPlot.

Parameters for different plot types are defined by subparameter groups, which are in the PlotMSPlotParameterGroups files.

Definition at line 46 of file PlotMSPlotParameters.h.

Constructor & Destructor Documentation

casa::PlotMSPlotParameters::PlotMSPlotParameters ( PlotFactoryPtr factory )

Non-Static //.

Constructor, which starts out with no subparameter groups.

casa::PlotMSPlotParameters::PlotMSPlotParameters ( const PlotMSPlotParameters & copy )

Copy constructor.

See operator=().

casa::PlotMSPlotParameters::~PlotMSPlotParameters ( )

Destructor.

Member Function Documentation

bool casa::PlotMSPlotParameters::equals	(	const PlotMSWatchedParameters &	other,
		int	updateFlags
	)		const `[virtual]`

Implements PlotMSWatchedParameters::equals().

Will return false if the other parameters are not of type PlotMSPlotParameters.

Implements casa::PlotMSWatchedParameters.

const Group* casa::PlotMSPlotParameters::group ( const String & name ) const

Returns the subparameters group with the given name, or NULL for none.

Group* casa::PlotMSPlotParameters::group ( const String & name )

void casa::PlotMSPlotParameters::groupUpdated	(	Group *	group,
		bool	requiresRedraw
	)		`[private]`

To be called when one of the groups is updated.

void casa::PlotMSPlotParameters::notifyWatchers	(	int	updateFlags,
		PlotMSParametersWatcher *	updater = `NULL`
	)		`[protected]`

Notifies any watchers that the parameters have been updated with the given flags.

If an updater is given, it is NOT notified.

Referenced by notifyWatchers().

void casa::PlotMSPlotParameters::notifyWatchers	(	const String &	updateName,
		PlotMSParametersWatcher *	updater = `NULL`
	)		`[inline, protected]`

Definition at line 213 of file PlotMSPlotParameters.h.

References notifyWatchers(), and casa::PlotMSWatchedParameters::UPDATE_FLAG().

PlotMSPlotParameters& casa::PlotMSPlotParameters::operator= ( const PlotMSPlotParameters & copy )

Copy operator.

Copies subparameters groups.

void casa::PlotMSPlotParameters::setGroup ( const Group & group )

Sets (or adds) the given group of subparameters in this object, cloning it.

template<class T >

void casa::PlotMSPlotParameters::setGroup ( ) [inline]

Sets (or adds) the default constructor of the templated type of subparameters group.

Definition at line 198 of file PlotMSPlotParameters.h.

References itsFactory_, and setGroup().

Referenced by setGroup().

template<class T >

const T* casa::PlotMSPlotParameters::typedGroup ( ) const [inline]

Returns the templated type of subparameters group, or NULL for none.

Definition at line 176 of file PlotMSPlotParameters.h.

References itsGroups_.

template<class T >

T* casa::PlotMSPlotParameters::typedGroup ( ) [inline]

Definition at line 183 of file PlotMSPlotParameters.h.

References itsGroups_.

Friends And Related Function Documentation

friend class PlotMSPlotParameters::Group [friend]

Definition at line 147 of file PlotMSPlotParameters.h.

Member Data Documentation

PlotFactoryPtr casa::PlotMSPlotParameters::itsFactory_ [protected]

Factory.

Definition at line 206 of file PlotMSPlotParameters.h.

Referenced by setGroup().

vector<Group*> casa::PlotMSPlotParameters::itsGroups_ [private]

Subparameter groups.

Definition at line 220 of file PlotMSPlotParameters.h.

Referenced by typedGroup().

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

code/plotms/Plots/PlotMSPlotParameters.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation