Base class describing event information for PixelCanvases. More...

#include <PixelCanvasEvent.h>

Inheritance diagram for casa::PixelCanvasEvent:

Public Member Functions
	PixelCanvasEvent (PixelCanvas *pc)
	Constructor, taking a pointer to a PixelCanvas.
virtual	~PixelCanvasEvent ()
	Destructor.
virtual PixelCanvas *	pixelCanvas () const
	Return a pointer to the PixelCanvas on which the event occurred.
Protected Member Functions
	PixelCanvasEvent ()
	(Required) default constructor.
	PixelCanvasEvent (const PixelCanvasEvent &other)
	(Required) copy constructor.
PixelCanvasEvent &	operator= (const PixelCanvasEvent &other)
	(Required) copy assignment.
Private Attributes
PixelCanvas *	itsPixelCanvas
	Store the PixelCanvas of the event here at construction.

Detailed Description

Base class describing event information for PixelCanvases.

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

"PixelCanvasEvents" describes "Events" (ie. things which happen at a measurable time) which occur on PixelCanvases.

Prerequisite

DisplayEvent

Synopsis

This class adds to the information stored in the DisplayEvent class. It adds information specific to events occuring on PixelCanvases, viz. a pointer to the PixelCanvas itself.

Example

Motivation

It is desirable to locate in a single place the information which is common to all events occuring on PixelCanvases.

Thrown Exceptions

.

Definition at line 79 of file PixelCanvasEvent.h.

Constructor & Destructor Documentation

casa::PixelCanvasEvent::PixelCanvasEvent ( PixelCanvas * pc )

Constructor, taking a pointer to a PixelCanvas.

virtual casa::PixelCanvasEvent::~PixelCanvasEvent ( ) [virtual]

Destructor.

casa::PixelCanvasEvent::PixelCanvasEvent ( ) [protected]

(Required) default constructor.

casa::PixelCanvasEvent::PixelCanvasEvent ( const PixelCanvasEvent & other ) [protected]

(Required) copy constructor.

Member Function Documentation

PixelCanvasEvent& casa::PixelCanvasEvent::operator= ( const PixelCanvasEvent & other ) [protected]

(Required) copy assignment.

virtual PixelCanvas* casa::PixelCanvasEvent::pixelCanvas ( ) const [inline, virtual]

Return a pointer to the PixelCanvas on which the event occurred.

Definition at line 90 of file PixelCanvasEvent.h.

References itsPixelCanvas.

Member Data Documentation

PixelCanvas* casa::PixelCanvasEvent::itsPixelCanvas [private]

Store the PixelCanvas of the event here at construction.

Definition at line 107 of file PixelCanvasEvent.h.

Referenced by pixelCanvas().

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

code/display/DisplayEvents/PixelCanvasEvent.h

Public Member Functions

Protected Member Functions

Private Attributes