#include <PlotMSPlotParameters.h>

Inheritance diagram for casa::PlotMSPlotParameters:

Classes
class	Group
	Static //. More...

Public Member Functions
	PlotMSPlotParameters (PlotFactoryPtr factory)
	Non-Static //. More...

	PlotMSPlotParameters (const PlotMSPlotParameters &copy)
	Copy constructor. More...

	~PlotMSPlotParameters ()
	Destructor. More...

bool	equals (const PlotMSWatchedParameters &other, int updateFlags) const
	Implements PlotMSWatchedParameters::equals(). More...

const Group *	group (const casacore::String &name) const
	Returns the subparameters group with the given name, or NULL for none. More...

Group *	group (const casacore::String &name)

template<class T >
const T *	typedGroup () const
	Returns the templated type of subparameters group, or NULL for none. More...

template<class T >
T *	typedGroup ()

void	setGroup (const Group &group)
	Sets (or adds) the given group of subparameters in this object, cloning it. More...

template<class T >
void	setGroup ()
	Sets (or adds) the default constructor of the templated type of subparameters group. More...

PlotMSPlotParameters &	operator= (const PlotMSPlotParameters &copy)
	Copy operator. More...

Public Member Functions inherited from casa::PlotMSWatchedParameters
	PlotMSWatchedParameters ()
	Non-Static //. More...

virtual	~PlotMSWatchedParameters ()
	Destructor. More...

void	addWatcher (PlotMSParametersWatcher *watcher)
	Adds/Removes the given watcher for this PlotMSParameters. More...

void	removeWatcher (PlotMSParametersWatcher *watcher)

void	holdNotification (PlotMSParametersWatcher *updater=NULL)
	Holds update notifications for any registered watchers. More...

void	releaseNotification ()
	Releases update notification; notifies all watchers of an update except for the one (if any) that called holdNotification. More...

virtual bool	operator== (const PlotMSWatchedParameters &other) const
	Equality operators. More...

virtual bool	operator!= (const PlotMSWatchedParameters &other) const

Protected Member Functions
void	notifyWatchers (int updateFlags, PlotMSParametersWatcher *updater=NULL)
	Notifies any watchers that the parameters have been updated with the given flags. More...

void	notifyWatchers (const casacore::String &updateName, PlotMSParametersWatcher *updater=NULL)

Protected Member Functions inherited from casa::PlotMSWatchedParameters
int	currentUpdateFlag () const
	Returns the current update flag. More...

void	updateFlag (int updateFlag, bool on=true)
	Provides access to children to indicate whether the given update flag should be turned on or off. More...

void	updateFlag (const casacore::String &updateFlagName, bool on=true)

void	updateFlags (int updateFlags)
	Provides access to children to indicate which update flags are on. More...

Protected Attributes
PlotFactoryPtr	itsFactory_
	Factory. More...

Private Member Functions
void	groupUpdated (Group *group, bool requiresRedraw)
	To be called when one of the groups is updated. More...

Private Attributes
std::vector< Group * >	itsGroups_
	Subparameter groups. More...

Friends
class	PlotMSPlotParameters::Group

Additional Inherited Members
Static Public Member Functions inherited from casa::PlotMSWatchedParameters
static int	REGISTER_UPDATE_FLAG (const casacore::String &name)
	Registers an update flag with the given name (if it is not already registered) and returns its flag value. More...

static void	UNREGISTER_UPDATE_FLAG (const casacore::String &name)
	Unregisters the given update flag, if it is registered. More...

static void	UNREGISTER_UPDATE_FLAG (int flag)

static int	UPDATE_FLAG (const casacore::String &name)
	Converts between an update flag's name and value, if valid. More...

static casacore::String	UPDATE_FLAG (int flag)

static std::vector< int >	UPDATE_FLAGS ()
	Returns all registered update flags. More...

static std::vector < casacore::String >	UPDATE_FLAG_NAMES ()

static int	ALL_UPDATE_FLAGS ()
	Returns all registered update flags as one or-ed value. More...

static std::vector< int >	UPDATE_FLAGS (int value)
	Returns all registered update flags that were turned on in the given flags value. More...

static std::vector < casacore::String >	UPDATE_FLAG_NAMES (int value)

Static Public Attributes inherited from casa::PlotMSWatchedParameters
static const int	NO_UPDATES
	Static //. More...

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 43 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 casacore::String & name ) const

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

Group* casa::PlotMSPlotParameters::group ( const casacore::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 casacore::String &	updateName,
		PlotMSParametersWatcher *	updater = `NULL`
	)

inlineprotected

Definition at line 212 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 196 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 173 of file PlotMSPlotParameters.h.

References itsGroups_.

template<class T >

T* casa::PlotMSPlotParameters::typedGroup ( )

inline

Definition at line 180 of file PlotMSPlotParameters.h.

References itsGroups_.

Friends And Related Function Documentation

friend class PlotMSPlotParameters::Group

friend

Definition at line 144 of file PlotMSPlotParameters.h.

Member Data Documentation

PlotFactoryPtr casa::PlotMSPlotParameters::itsFactory_

protected

Factory.

Definition at line 205 of file PlotMSPlotParameters.h.

Referenced by setGroup().

std::vector<Group*> casa::PlotMSPlotParameters::itsGroups_

private

Subparameter groups.

Definition at line 219 of file PlotMSPlotParameters.h.

Referenced by typedGroup().

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

casa/code/plotms/Plots/PlotMSPlotParameters.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation