casa::PassiveCachingDD Class Reference

Class providing passive behaviour for CachingDisplayDatas. More...

#include <PassiveCachingDD.h>

Inheritance diagram for casa::PassiveCachingDD:

List of all members.

Public Member Functions
	PassiveCachingDD ()
	Constructor.
virtual	~PassiveCachingDD ()
	Destructor.
virtual Bool	linToWorld (Vector< Double > &world, const Vector< Double > &lin)
	Coordinate transformation handlers, called by WorldCanvasHolder.
virtual Bool	worldToLin (Vector< Double > &lin, const Vector< Double > &world)
virtual String	showPosition (const Vector< Double > &world, const Bool &displayAxesOnly=False)
	Format a string containing coordinate or value information at the given world coordinate.
virtual String	showValue (const Vector< Double > &world)
	Format a string containing value information at the given world coordinate.
virtual Vector< String >	worldAxisNames () const
	World axis information suppliers.
virtual Vector< String >	worldAxisUnits () const
const Unit	dataUnit () const
const IPosition	dataShape () const
uInt	dataDim () const
std::vector< int >	displayAxes () const
virtual uInt	nelements (const WorldCanvasHolder &wcHolder) const
	Return the number of display elements (ie.
virtual uInt	nelements () const
	and non-specific
virtual void	setDefaultOptions ()
	Install the default options for this DisplayData.
virtual Bool	setOptions (Record &rec, Record &recOut)
	Apply options stored in rec to the DisplayData.
virtual Record	getOptions (bool scrub=false) const
	Retrieve the current and default options and parameter types.
virtual void	refreshEH (const WCRefreshEvent &ev)
	Negotiatiate WorldCanvas linear coordinate system when asked to do so by the WorldCanvasHolder.
virtual Bool	sizeControl (WorldCanvasHolder &, AttributeBuffer &)
	Set (coordinate) state of WCH's WC.
virtual void	cleanup ()
	Tidy up the elements of this DisplayData.
Protected Member Functions
virtual AttributeBuffer	optionsAsAttributes ()
	Return the current options of this DisplayData as an AttributeBuffer.
	PassiveCachingDD (const PassiveCachingDD &other)
	(Required) copy constructor.
void	operator= (const PassiveCachingDD &other)
	(Required) copy assignment.

---

Detailed Description

Class providing passive behaviour for CachingDisplayDatas.

Synopsis

A "passive" DisplayData is one which can only be used in conjunction with another non-passive DisplayData. As such, it will not negotiate coordinates on a WorldCanvas, nor will it provide coordinate conversion capabilities.

Definition at line 48 of file PassiveCachingDD.h.

---

Constructor & Destructor Documentation

casa::PassiveCachingDD::PassiveCachingDD

(

)

Constructor.

virtual casa::PassiveCachingDD::~PassiveCachingDD

(

)

[virtual]

Destructor.

casa::PassiveCachingDD::PassiveCachingDD

(

const PassiveCachingDD &

other

)

[protected]

(Required) copy constructor.

---

Member Function Documentation

virtual void casa::PassiveCachingDD::cleanup

(

)

[virtual]

Tidy up the elements of this DisplayData.

Implements casa::DisplayData.

uInt casa::PassiveCachingDD::dataDim

(

)

const [inline, virtual]

Implements casa::DisplayData.

Reimplemented in casa::RegionShape.

Definition at line 88 of file PassiveCachingDD.h.

const IPosition casa::PassiveCachingDD::dataShape

(

)

const [inline, virtual]

Implements casa::DisplayData.

Reimplemented in casa::RegionShape.

Definition at line 85 of file PassiveCachingDD.h.

const Unit casa::PassiveCachingDD::dataUnit

(

)

const [inline, virtual]

Implements casa::DisplayData.

Reimplemented in casa::RegionShape.

Definition at line 82 of file PassiveCachingDD.h.

std::vector<int> casa::PassiveCachingDD::displayAxes

(

)

const [inline, virtual]

Implements casa::DisplayData.

Reimplemented in casa::RegionShape.

Definition at line 91 of file PassiveCachingDD.h.

virtual Record casa::PassiveCachingDD::getOptions

(

bool

scrub = false

)

const [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::AxesDisplayData, casa::DrawingDisplayData, casa::PassiveTableDD, casa::SkyCatOverlayDD, and casa::WorldAxesDD.

virtual Bool casa::PassiveCachingDD::linToWorld	(	Vector< Double > &	world,
		const Vector< Double > &	lin
	)			[virtual]

Coordinate transformation handlers, called by WorldCanvasHolder.

These functions simply return False because this DisplayData is passive.

Implements casa::DisplayData.

virtual uInt casa::PassiveCachingDD::nelements

(

)

const [virtual]

and non-specific

Implements casa::DisplayData.

virtual uInt casa::PassiveCachingDD::nelements

(

const WorldCanvasHolder &

wcHolder

)

const [virtual]

Return the number of display elements (ie.

drawable images) in this DisplayData.

Implements casa::DisplayData.

void casa::PassiveCachingDD::operator=

(

const PassiveCachingDD &

other

)

[protected]

(Required) copy assignment.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::AxesDisplayData, casa::DrawingDisplayData, casa::PassiveTableDD, casa::SkyCatOverlayDD, and casa::WorldAxesDD.

virtual AttributeBuffer casa::PassiveCachingDD::optionsAsAttributes

(

)

[protected, virtual]

Return the current options of this DisplayData as an AttributeBuffer.

The caller must delete the returned buffer.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::AxesDisplayData, casa::DrawingDisplayData, casa::PassiveTableDD, casa::SkyCatOverlayDD, and casa::WorldAxesDD.

virtual void casa::PassiveCachingDD::refreshEH

(

const WCRefreshEvent &

ev

)

[virtual]

Negotiatiate WorldCanvas linear coordinate system when asked to do so by the WorldCanvasHolder.

In this implementation, simply return False to indicate that this DisplayData will not negotiate coordinates: it is a passive DisplayData.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::DrawingDisplayData.

virtual void casa::PassiveCachingDD::setDefaultOptions

(

)

[virtual]

Install the default options for this DisplayData.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::AxesDisplayData, casa::DrawingDisplayData, casa::PassiveTableDD, casa::SkyCatOverlayDD, and casa::WorldAxesDD.

virtual Bool casa::PassiveCachingDD::setOptions	(	Record &	rec,
		Record &	recOut
	)			[virtual]

Apply options stored in rec to the DisplayData.

A return value of True means a refresh is needed. recOut contains any fields which were implicitly changed as a result of the call to this function.

Reimplemented from casa::CachingDisplayData.

Reimplemented in casa::AxesDisplayData, casa::DrawingDisplayData, casa::PassiveTableDD, casa::SkyCatOverlayDD, and casa::WorldAxesDD.

virtual String casa::PassiveCachingDD::showPosition	(	const Vector< Double > &	world,
		const Bool &	displayAxesOnly = False
	)			[virtual]

Format a string containing coordinate or value information at the given world coordinate.

They simply return empty Strings because this DisplayData is passive.

Implements casa::DisplayData.

virtual String casa::PassiveCachingDD::showValue

(

const Vector< Double > &

world

)

[virtual]

Format a string containing value information at the given world coordinate.

Implements casa::DisplayData.

virtual Bool casa::PassiveCachingDD::sizeControl	(	WorldCanvasHolder &	wcHolder,
		AttributeBuffer &	holderBuf
	)			[inline, virtual]

Set (coordinate) state of WCH's WC.

Called by WCH::executeSizeControl(). (See important notes on interface and implementation of this function in the class synopsis above).

Implements casa::DisplayData.

Definition at line 120 of file PassiveCachingDD.h.

References casacore::False.

virtual Vector<String> casa::PassiveCachingDD::worldAxisNames

(

)

const [virtual]

World axis information suppliers.

Implements casa::DisplayData.

virtual Vector<String> casa::PassiveCachingDD::worldAxisUnits

(

)

const [virtual]

Implements casa::DisplayData.

virtual Bool casa::PassiveCachingDD::worldToLin	(	Vector< Double > &	lin,
		const Vector< Double > &	world
	)			[virtual]

Implements casa::DisplayData.

---

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

• code/display/DisplayDatas/PassiveCachingDD.h