casa::DisplayDataEvent Class Reference

Class for events sent by DisplayDatas. More...

#include <DisplayDataEvent.h>

Inheritance diagram for casa::DisplayDataEvent:

Public Member Functions
	DisplayDataEvent (DisplayData *dd)
	Constructor, taking a pointer to a constant DD.
virtual	~DisplayDataEvent ()
	Destructor.
virtual DisplayData *	displayData () const
	Return a pointer to the DD that generated the event.
Protected Member Functions
	DisplayDataEvent ()
	(Required) default constructor.
	DisplayDataEvent (const DisplayDataEvent &other)
	(Required) copy constructor.
DisplayDataEvent &	operator= (const DisplayDataEvent &other)
	(Required) copy assignment.
Private Attributes
DisplayData *	itsDisplayData
	Store the DisplayData of the event here at construction.

Detailed Description

Class for events sent by DisplayDatas.

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

"DisplayDataEvents" describes "Events" (ie. things which happen at a measurable time) which are sent by DisplayDatas.

Prerequisite

DisplayEvent

Synopsis

This class adds to the information stored in the DisplayEvent class. It adds a pointer to the DisplayData itself.

Example

Motivation

There was a need for events that can be sent by display datas to signal modifications. DisplayEHs can listen to these events from any display data that transmits DisplayDataEvents

Thrown Exceptions

.

Definition at line 79 of file DisplayDataEvent.h.

Constructor & Destructor Documentation

casa::DisplayDataEvent::DisplayDataEvent ( DisplayData * dd )

Constructor, taking a pointer to a constant DD.

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

Destructor.

casa::DisplayDataEvent::DisplayDataEvent ( ) [protected]

(Required) default constructor.

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

(Required) copy constructor.

Member Function Documentation

virtual DisplayData* casa::DisplayDataEvent::displayData ( ) const [inline, virtual]

Return a pointer to the DD that generated the event.

Definition at line 90 of file DisplayDataEvent.h.

References itsDisplayData.

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

(Required) copy assignment.

Reimplemented from casa::DisplayEvent.

Reimplemented in casa::DDModEvent.

Member Data Documentation

DisplayData* casa::DisplayDataEvent::itsDisplayData [private]

Store the DisplayData of the event here at construction.

Definition at line 108 of file DisplayDataEvent.h.

Referenced by displayData().

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

code/display/DisplayEvents/DisplayDataEvent.h