casa::WedgeDD Class Reference
[DisplayDatas]

#include <WedgeDD.h>

Inheritance diagram for casa::WedgeDD:

Inheritance graph
[legend]
Collaboration diagram for casa::WedgeDD:

Collaboration graph
[legend]
List of all members.

Detailed Description

A DisplayData to draw color wedges.

Intended use:

Part of API

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

This DisplayData can be created by itself. It's main task though is to set up a coordinate system form the data range and units of another DisplayData. The user can control this through options in this DisplayData: "datamin", "datamax, "dataunit" and "powercycles".

Example

Motivation

Users want wedges

To Do

wedges

Definition at line 81 of file WedgeDD.h.

Public Member Functions

 WedgeDD ()
virtual ~WedgeDD ()
 Destructor.
virtual void setup ()
 Constructor help function, creates coordinatesystem and fills data Matrix.
virtual void updateCsys ()
 The coordinate sydtem needs to be update when the data range changes.
virtual Bool labelAxes (const WCRefreshEvent &ev)
 Axis labeller, 5th step in the WCHolder refresh cycle.
virtual const Unit dataUnit ()
 Return the data unit.
virtual String showValue (const Vector< Double > &world)
 Format the wedge value at the given world position.
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 ()
 Retrieve the current and default options and parameter types.
virtual Display::DisplayDataType classType ()
 Return the type of this DisplayData.
virtual CachingDisplayMethodnewDisplayMethod (WorldCanvas *worldCanvas, AttributeBuffer *wchAttributes, AttributeBuffer *ddAttributes, CachingDisplayData *dd)
 Create a new AxesDisplayMethod for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.
virtual AttributeBuffer optionsAsAttributes ()
 Return the current options of this DisplayData as an AttributeBuffer.
virtual void notifyUnregister (WorldCanvasHolder &wcHolder, Bool ignoreRefresh=False)
 Take actions on removal from WC[H] (notably, deletion of drawlists).

Protected Member Functions

 WedgeDD (const WedgeDD &other)
 (Required) copy constructor.
void operator= (const WedgeDD &other)
 (Required) copy assignment.

Private Attributes

Float itsMin
 Data minimum and maximum to set up the coordinate system.
Float itsMax
uInt itsLength
 the length of the Vector
String itsDataUnit
 the unit of the input data
WCCSNLAxisLabeller itsAxisLabeller
 the axis labeller
Matrix< FloatitsColorbar
 The actual colorbar data.
CoordinateSystem itsCoordinateSystem
 the local coordinate system - gets exported to the parent DD
Float itsPowerCycles
 the power law adjustment for for the scle handler
WCPowerScaleHandleritsPowerScaleHandler
String itsOptionsMode

Friends

class WedgeDM


Constructor & Destructor Documentation

casa::WedgeDD::WedgeDD (  ) 

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

Destructor.

casa::WedgeDD::WedgeDD ( const WedgeDD other  )  [protected]

(Required) copy constructor.


Member Function Documentation

virtual void casa::WedgeDD::setup (  )  [virtual]

Constructor help function, creates coordinatesystem and fills data Matrix.

virtual void casa::WedgeDD::updateCsys (  )  [virtual]

The coordinate sydtem needs to be update when the data range changes.

virtual Bool casa::WedgeDD::labelAxes ( const WCRefreshEvent ev  )  [virtual]

Axis labeller, 5th step in the WCHolder refresh cycle.

Reimplemented from casa::DisplayData.

virtual const Unit casa::WedgeDD::dataUnit (  )  [virtual]

Return the data unit.

Implements casa::DisplayData.

virtual String casa::WedgeDD::showValue ( const Vector< Double > &  world  )  [virtual]

Format the wedge value at the given world position.

Implements casa::DisplayData.

virtual void casa::WedgeDD::setDefaultOptions (  )  [virtual]

Install the default options for this DisplayData.

Reimplemented from casa::ActiveCaching2dDD.

virtual Bool casa::WedgeDD::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::ActiveCaching2dDD.

virtual Record casa::WedgeDD::getOptions (  )  [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

virtual Display::DisplayDataType casa::WedgeDD::classType (  )  [inline, virtual]

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 118 of file WedgeDD.h.

References casa::Display::Raster.

virtual CachingDisplayMethod* casa::WedgeDD::newDisplayMethod ( WorldCanvas worldCanvas,
AttributeBuffer wchAttributes,
AttributeBuffer ddAttributes,
CachingDisplayData dd 
) [virtual]

Create a new AxesDisplayMethod for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.

The tag is a unique number used to identify the age of the newly constructed CachingDisplayMethod.

Implements casa::CachingDisplayData.

virtual AttributeBuffer casa::WedgeDD::optionsAsAttributes (  )  [virtual]

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

virtual void casa::WedgeDD::notifyUnregister ( WorldCanvasHolder wcHolder,
Bool  ignoreRefresh = False 
) [virtual]

Take actions on removal from WC[H] (notably, deletion of drawlists).

Reimplemented from casa::CachingDisplayData.

void casa::WedgeDD::operator= ( const WedgeDD other  )  [protected]

(Required) copy assignment.


Friends And Related Function Documentation

friend class WedgeDM [friend]

Definition at line 148 of file WedgeDD.h.


Member Data Documentation

Float casa::WedgeDD::itsMin [private]

Data minimum and maximum to set up the coordinate system.

Definition at line 150 of file WedgeDD.h.

Float casa::WedgeDD::itsMax [private]

Definition at line 150 of file WedgeDD.h.

uInt casa::WedgeDD::itsLength [private]

the length of the Vector

Definition at line 152 of file WedgeDD.h.

String casa::WedgeDD::itsDataUnit [private]

the unit of the input data

Definition at line 154 of file WedgeDD.h.

Float casa::WedgeDD::itsPowerCycles [private]

the power law adjustment for for the scle handler

Definition at line 157 of file WedgeDD.h.

WCPowerScaleHandler* casa::WedgeDD::itsPowerScaleHandler [private]

Definition at line 158 of file WedgeDD.h.

String casa::WedgeDD::itsOptionsMode [private]

Definition at line 160 of file WedgeDD.h.

WCCSNLAxisLabeller casa::WedgeDD::itsAxisLabeller [private]

the axis labeller

Definition at line 163 of file WedgeDD.h.

Matrix<Float> casa::WedgeDD::itsColorbar [private]

The actual colorbar data.

Definition at line 165 of file WedgeDD.h.

CoordinateSystem casa::WedgeDD::itsCoordinateSystem [private]

the local coordinate system - gets exported to the parent DD

Reimplemented from casa::ActiveCaching2dDD.

Definition at line 167 of file WedgeDD.h.


The documentation for this class was generated from the following file:
Generated on Mon Sep 1 22:48:26 2008 for NRAOCASA by  doxygen 1.5.1