casa::CachingDisplayMethod Class Reference

Assistance class for auto-caching of DisplayData objects. More...

#include <CachingDisplayMethod.h>

Inheritance diagram for casa::CachingDisplayMethod:

Public Member Functions
	CachingDisplayMethod (WorldCanvas *worldCanvas, AttributeBuffer *wchAttributes, AttributeBuffer *ddAttributes, CachingDisplayData *parentDisplayData)
	Constructor. More...
virtual	~CachingDisplayMethod ()
	Destructor. More...
virtual WorldCanvas *	worldCanvas ()
	Return the WorldCanvas recorded in this CachingDisplayMethod. More...
virtual void	draw (Display::RefreshReason reason, WorldCanvasHolder &wcHolder)
	Draw this slice of data on the supplied WorldCanvasHolder. More...
Public Member Functions inherited from casa::DisplayMethod
	DisplayMethod (DisplayData *parentDisplayData)
	Constructor. More...
virtual	~DisplayMethod ()
	Destructor. More...
virtual void	cleanup ()
	clear drawlist state. More...
void	addRestriction (Attribute &newAt, casacore::Bool permanent)
	Set & remove restrictions. More...
void	addRestrictions (AttributeBuffer &newBuf)
void	setRestriction (Attribute &newAt)
void	setRestrictions (AttributeBuffer &newBuf)
void	removeRestriction (const casacore::String &name)
casacore::Bool	existRestriction (const casacore::String &name)
void	clearRestrictions ()
casacore::Bool	matches (Attribute &at)
	match restriction More...
casacore::Bool	matches (AttributeBuffer &atBuf)

Protected Member Functions
	CachingDisplayMethod ()
	(Required) default constructor. More...
	CachingDisplayMethod (const CachingDisplayMethod &other)
	(Required) copy constructor. More...
void	operator= (const CachingDisplayMethod &other)
	(Required) copy assignment. More...
virtual casacore::Bool	drawIntoList (Display::RefreshReason reason, WorldCanvasHolder &wcHolder)=0
	Draw into a cached drawing list, called by draw function. More...
Protected Member Functions inherited from casa::DisplayMethod
	DisplayMethod ()
	(Required) default constructor. More...
	DisplayMethod (const DisplayMethod &other)
	(Required) copy constructor. More...
void	operator= (const DisplayMethod &other)
	(Required) copy assignment. More...
DisplayData *	parentDisplayData ()
	Return the parent DisplayData. More...

Private Attributes
WorldCanvas *	itsWorldCanvas
	Store for the WorldCanvas which this has previously drawn upon. More...
AttributeBuffer *	itsWCHAttributes
	Store for WorldCanvasHolder- and DisplayData-specific AttributeBuffers. More...
AttributeBuffer *	itsDDAttributes
casacore::Bool	itsHasList
	Do we have a cached drawing list? More...
casacore::uInt	itsCachedDrawingList
	Store for cached drawing list number. More...

Additional Inherited Members
Protected Attributes inherited from casa::DisplayMethod
AttributeBuffer	restrictions

Detailed Description

Assistance class for auto-caching of DisplayData objects.

Intended use:

Public interface

Prerequisite

• DisplayMethod
• CachingDisplayData

Etymology

"CachingDisplayMethod" is an implementation of a DisplayMethod which provides a single element in a cache of individual depictions of some data.

Synopsis

Definition at line 66 of file CachingDisplayMethod.h.

Constructor & Destructor Documentation

casa::CachingDisplayMethod::CachingDisplayMethod	(	WorldCanvas *	worldCanvas,
		AttributeBuffer *	wchAttributes,
		AttributeBuffer *	ddAttributes,
		CachingDisplayData *	parentDisplayData
	)

Constructor.

A single instance of a CachingDisplayMethod is setup to draw on a particular WorldCanvas, and only when particular conditions, as stored in the provided AttributeBuffers, are met. The parent DisplayData is given in parentDisplayData.

virtual casa::CachingDisplayMethod::~CachingDisplayMethod ( )

virtual

Destructor.

casa::CachingDisplayMethod::CachingDisplayMethod ( )

protected

(Required) default constructor.

casa::CachingDisplayMethod::CachingDisplayMethod ( const CachingDisplayMethod &  other )

protected

(Required) copy constructor.

Member Function Documentation

virtual void casa::CachingDisplayMethod::draw ( Display::RefreshReason  reason, WorldCanvasHolder &  wcHolder  )

virtual

Draw this slice of data on the supplied WorldCanvasHolder.

Implements casa::DisplayMethod.

virtual casacore::Bool casa::CachingDisplayMethod::drawIntoList ( Display::RefreshReason  reason, WorldCanvasHolder &  wcHolder  )

protectedpure virtual

Draw into a cached drawing list, called by draw function.

The return value is set false if the DM could not draw or does not wish a drawlist to be saved.

Implemented in casa::MSAsRasterDM, casa::RegionShapeDM, casa::WedgeDM, casa::TblAsXYDM, casa::TblAsRasterDM, casa::TblAsContourDM, casa::Histogram2dDM, casa::Profile2dDM, casa::SkyCatOverlayDM, casa::DrawingDisplayMethod, casa::AxesDisplayMethod, and casa::WorldAxesDM.

void casa::CachingDisplayMethod::operator= ( const CachingDisplayMethod &  other )

protected

(Required) copy assignment.

virtual WorldCanvas* casa::CachingDisplayMethod::worldCanvas ( )

inlinevirtual

Return the WorldCanvas recorded in this CachingDisplayMethod.

Definition at line 84 of file CachingDisplayMethod.h.

References itsWorldCanvas.

Referenced by casa::MSAsRasterDM::drawIntoList().

Member Data Documentation

casacore::uInt casa::CachingDisplayMethod::itsCachedDrawingList

private

Store for cached drawing list number.

Definition at line 122 of file CachingDisplayMethod.h.

AttributeBuffer * casa::CachingDisplayMethod::itsDDAttributes

private

Definition at line 116 of file CachingDisplayMethod.h.

casacore::Bool casa::CachingDisplayMethod::itsHasList

private

Do we have a cached drawing list?

Definition at line 119 of file CachingDisplayMethod.h.

AttributeBuffer* casa::CachingDisplayMethod::itsWCHAttributes

private

Store for WorldCanvasHolder- and DisplayData-specific AttributeBuffers.

Definition at line 116 of file CachingDisplayMethod.h.

WorldCanvas* casa::CachingDisplayMethod::itsWorldCanvas

private

Store for the WorldCanvas which this has previously drawn upon.

Definition at line 112 of file CachingDisplayMethod.h.

Referenced by worldCanvas().

---

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

• casa/code/display/DisplayDatas/CachingDisplayMethod.h