casa::MWCAnimator Class Reference

Animator for MultiWCHolder class. More...

#include <MWCAnimator.h>

Public Member Functions
	MWCAnimator ()
	Constructor which makes an isolated MWCAnimator. More...
	MWCAnimator (MultiWCHolder &mholder)
	Constructor which makes a MWCAnimator which is connected to the specified MultiWCHolder. More...
virtual	~MWCAnimator ()
	Destructor. More...
virtual void	addMWCHolder (MultiWCHolder &mholder)
	Add or remove a MultiWCHolder, or remove all MultiWCHolders from this MWCAnimator. More...
virtual void	removeMWCHolder (MultiWCHolder &mholder)
virtual void	removeMWCHolders ()
virtual void	setLinearRestrictions (AttributeBuffer &restrictions, const AttributeBuffer &increments)
	Install the given restriction, spaced by the given increment, on all MultiWCHolders. More...
template<class T >
void	setLinearRestriction (const casacore::String &name, const T &value, const T &increment, const T &tol)
	Install a restriction of the given name, and initial value and increment, on all MultiWCHolders. More...
virtual void	setLinearRestriction (const casacore::RecordInterface &rec)
	Install a restriction described by the given casacore::RecordInterface, on all MultiWCHolders. More...
virtual void	removeRestriction (const casacore::String &name)
	Remove a restriction (including a 'linear' (ramped) one). More...

Private Member Functions
casacore::Bool	isAlreadyRegistered (const MultiWCHolder &holder)
	Do we already have this MultiWCHolder registered? More...

Private Attributes
std::list< MultiWCHolder * >	itsMWCHList
	The list of MultiWCHolders that are connected to this MWCAnimator. More...

Detailed Description

Animator for MultiWCHolder class.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

Synopsis

Motivation

Definition at line 64 of file MWCAnimator.h.

Constructor & Destructor Documentation

casa::MWCAnimator::MWCAnimator

(

)

Constructor which makes an isolated MWCAnimator.

casa::MWCAnimator::MWCAnimator

(

MultiWCHolder &

mholder

)

Constructor which makes a MWCAnimator which is connected to the specified MultiWCHolder.

virtual casa::MWCAnimator::~MWCAnimator ( )

virtual

Destructor.

Member Function Documentation

virtual void casa::MWCAnimator::addMWCHolder ( MultiWCHolder &  mholder )

virtual

Add or remove a MultiWCHolder, or remove all MultiWCHolders from this MWCAnimator.

mholder is added at the end of the list.

casacore::Bool casa::MWCAnimator::isAlreadyRegistered ( const MultiWCHolder &  holder )

private

Do we already have this MultiWCHolder registered?

virtual void casa::MWCAnimator::removeMWCHolder ( MultiWCHolder &  mholder )

virtual

virtual void casa::MWCAnimator::removeMWCHolders ( )

virtual

virtual void casa::MWCAnimator::removeRestriction ( const casacore::String &  name )

virtual

Remove a restriction (including a 'linear' (ramped) one).

(Can be (and is) used to remove 'bindex' restriction).

template<class T >

void casa::MWCAnimator::setLinearRestriction	(	const casacore::String &	name,
		const T &	value,
		const T &	increment,
		const T &	tol
	)

Install a restriction of the given name, and initial value and increment, on all MultiWCHolders.

This is templated and the templates are valid for any type which can be added to an AttributeBuffer. This function simply sets up a single-element AttributeBuffer and calls setLinearRestrictions.

virtual void casa::MWCAnimator::setLinearRestriction ( const casacore::RecordInterface &  rec )

virtual

Install a restriction described by the given casacore::RecordInterface, on all MultiWCHolders.

This method simply extracts the fields name, value, and increment from rec, and calls the explicit version of setLinearRestriction. The value and increment fields can contain either casacore::Int, Float or casacore::Double data at the moment.

virtual void casa::MWCAnimator::setLinearRestrictions ( AttributeBuffer &  restrictions, const AttributeBuffer &  increments  )

virtual

Install the given restriction, spaced by the given increment, on all MultiWCHolders.

Ultimately this will go private and be called (for example) by next(), prev(). But for now we leave it public for testing purposes. After being called, restrictions is the set of restrictions which have been placed on the final WorldCanvasHolder of the final MultiWCHolder in the list.

Member Data Documentation

std::list<MultiWCHolder *> casa::MWCAnimator::itsMWCHList

private

The list of MultiWCHolders that are connected to this MWCAnimator.

Definition at line 123 of file MWCAnimator.h.

---

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

• casa/code/display/DisplayEvents/MWCAnimator.h