casa::WorldAxesDD Class Reference

A DisplayData to setup a World coordinate plot. More...

#include <WorldAxesDD.h>

Inheritance diagram for casa::WorldAxesDD:

Public Member Functions
	WorldAxesDD ()
	Constructor.
virtual	~WorldAxesDD ()
	Destructor.
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 CachingDisplayMethod *	newDisplayMethod (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 String	spectralUnit () const
virtual String	velocityType () const
virtual String	axisText (const WorldCanvas *wc, const uInt axisNo) const
virtual String	xAxisText (const WorldCanvas *wc=0) const
	Get the X and Y axis text Strings for labelling.
virtual String	yAxisText (const WorldCanvas *wc=0) const
String	dataType () const
	Pure virtual function from DisplayData.
std::string	errorMessage () const
Protected Member Functions
	WorldAxesDD (const WorldAxesDD &other)
	(Required) copy constructor.
void	operator= (const WorldAxesDD &other)
	(Required) copy assignment.
Private Member Functions
void	installDefaultOptions ()
	Install the default options for this DisplayData.
Private Attributes
DParameterChoice *	itsParamSpectralUnit
	Set Spectral preference (options).
DParameterChoice *	itsParamVelocityType

Detailed Description

A DisplayData to setup a World coordinate plot.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Definition at line 58 of file WorldAxesDD.h.

Constructor & Destructor Documentation

casa::WorldAxesDD::WorldAxesDD ( )

Constructor.

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

Destructor.

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

(Required) copy constructor.

Member Function Documentation

virtual String casa::WorldAxesDD::axisText	(	const WorldCanvas *	wc,
		const uInt	axisNo
	)			const `[virtual]`

String casa::WorldAxesDD::dataType ( ) const [inline, virtual]

Pure virtual function from DisplayData.

.\.

Implements casa::DisplayData.

Definition at line 107 of file WorldAxesDD.h.

std::string casa::WorldAxesDD::errorMessage ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 111 of file WorldAxesDD.h.

virtual Record casa::WorldAxesDD::getOptions ( bool scrub = false ) const [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::AxesDisplayData.

void casa::WorldAxesDD::installDefaultOptions ( ) [private]

Install the default options for this DisplayData.

Reimplemented from casa::CachingDisplayData.

virtual CachingDisplayMethod* casa::WorldAxesDD::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.

Reimplemented from casa::AxesDisplayData.

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

(Required) copy assignment.

Reimplemented from casa::AxesDisplayData.

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

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::AxesDisplayData.

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

Install the default options for this DisplayData.

Reimplemented from casa::AxesDisplayData.

virtual Bool casa::WorldAxesDD::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::AxesDisplayData.

virtual String casa::WorldAxesDD::spectralUnit ( ) const [inline, virtual]

Definition at line 94 of file WorldAxesDD.h.

References itsParamSpectralUnit, and casa::DParameterChoice::value().

virtual String casa::WorldAxesDD::velocityType ( ) const [inline, virtual]

Definition at line 98 of file WorldAxesDD.h.

References itsParamVelocityType, and casa::DParameterChoice::value().

virtual String casa::WorldAxesDD::xAxisText ( const WorldCanvas * wc = 0 ) const [virtual]