casa::SkyCatOverlayDD Class Reference

Simple implementation of a cached DisplayData for sky catalogue overlays. More...

#include <SkyCatOverlayDD.h>

Inheritance diagram for casa::SkyCatOverlayDD:

Public Member Functions
	SkyCatOverlayDD (Table *table)
	Constructor taking a pointer to an already constructed Table.
	SkyCatOverlayDD (const String tablename)
	Constructor taking a String which describes the full pathname of a Table on disk.
virtual	~SkyCatOverlayDD ()
	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 Display::DisplayDataType	classType ()
	Return the type of this DisplayData.
String	dataType () const
	Pure virtual function from DisplayData.
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	nameColumn () const
	Get the column name for text labelling.
virtual Float	lineWidth () const
	Get the line width for labelling.
virtual Display::Marker	markerType () const
	Get the marker type, size and color.
virtual Int	markerSize () const
virtual String	markerColor () const
virtual String	mapColumn () const
	Get the column name for value-size mapping.
virtual String	charFont () const
	Get the character font, size, color and angle for labelling.
virtual Float	charSize () const
virtual String	charColor () const
virtual Int	charAngle () const
virtual Float	labelXOffset () const
	Get the label x and y offsets (in character height).
virtual Float	labelYOffset () const
virtual Bool	conformsToCS (const WorldCanvas &wch)
	Determine ability to draw, given current canvas coordinate state.
std::string	errorMessage () const
Protected Member Functions
	SkyCatOverlayDD ()
	(Required) default constructor.
	SkyCatOverlayDD (const SkyCatOverlayDD &other)
	(Required) copy constructor.
void	operator= (const SkyCatOverlayDD &other)
	(Required) copy assignment.
virtual Bool	determineDirectionColumnMapping ()
	Attempt to determine which columns map to longitude, latitude, and type.
Unit	columnUnit (const String columnName) const
	Return the unit of a given column in the table.
Private Member Functions
void	constructParameters ()
	Construct and destruct the parameter set.
void	destructParameters ()
Private Attributes
Vector< String >	itsColumnNames
	Store the column names here.
String	itsLongitudeColumn
	Option: what type of coordinates are provided? String itsCoordinateType;.
Unit	itsLongitudeUnit
String	itsLatitudeColumn
	Which column is mapped to the latitude coordinate, and what is its unit?
Unit	itsLatitudeUnit
String	itsDirectionTypeColumn
	Which column is mapped to epoch.
DParameterChoice *	itsParamNameColumn
	Option: which column is mapped to the name?
DParameterRange< Int > *	itsParamLineWidth
	plot line width
DParameterMapKeyChoice *	itsParamMarkerType
	Marker type, size and color.
DParameterRange< Int > *	itsParamMarkerSize
DParameterColorChoice *	itsParamMarkerColor
DParameterChoice *	itsParamMapColumn
DParameterChoice *	itsParamCharacterFont
	Labelling character font, size, color and angle.
DParameterRange< Float > *	itsParamCharacterSize
DParameterColorChoice *	itsParamCharacterColor
DParameterRange< Int > *	itsParamCharacterAngle
DParameterRange< Float > *	itsParamLabelXOffset
	Labelling character offsets in character height units.
DParameterRange< Float > *	itsParamLabelYOffset
Friends
class	SkyCatOverlayDM
	Allow the DisplayMethod to access the private data.

Detailed Description

Simple implementation of a cached DisplayData for sky catalogue overlays.

Definition at line 49 of file SkyCatOverlayDD.h.

Constructor & Destructor Documentation

casa::SkyCatOverlayDD::SkyCatOverlayDD ( Table * table )

Constructor taking a pointer to an already constructed Table.

casa::SkyCatOverlayDD::SkyCatOverlayDD ( const String tablename )

Constructor taking a String which describes the full pathname of a Table on disk.

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

Destructor.

casa::SkyCatOverlayDD::SkyCatOverlayDD ( ) [protected]

(Required) default constructor.

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

(Required) copy constructor.

Member Function Documentation

virtual Int casa::SkyCatOverlayDD::charAngle ( ) const [inline, virtual]

Definition at line 139 of file SkyCatOverlayDD.h.

References itsParamCharacterAngle, and casa::DParameterRange< T >::value().

virtual String casa::SkyCatOverlayDD::charColor ( ) const [inline, virtual]

Definition at line 136 of file SkyCatOverlayDD.h.

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

virtual String casa::SkyCatOverlayDD::charFont ( ) const [inline, virtual]

Get the character font, size, color and angle for labelling.

Definition at line 130 of file SkyCatOverlayDD.h.

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

virtual Float casa::SkyCatOverlayDD::charSize ( ) const [inline, virtual]

Definition at line 133 of file SkyCatOverlayDD.h.

References itsParamCharacterSize, and casa::DParameterRange< T >::value().

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

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 76 of file SkyCatOverlayDD.h.

References casa::Display::CanvasAnnotation.

Unit casa::SkyCatOverlayDD::columnUnit ( const String columnName ) const [protected]

Return the unit of a given column in the table.

This is extracted from the first column keyword matching the pattern ^[uU][nN][iI][tT]$. If no unit keyword is available, the returned unit is a null unit.

virtual Bool casa::SkyCatOverlayDD::conformsToCS ( const WorldCanvas & wch ) [virtual]

Determine ability to draw, given current canvas coordinate state.

This DD requires direction coordinates in both X and Y axis codes.

Reimplemented from casa::DisplayData.

void casa::SkyCatOverlayDD::constructParameters ( ) [private]

Construct and destruct the parameter set.

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

Pure virtual function from DisplayData.

.\.

Implements casa::DisplayData.

Definition at line 80 of file SkyCatOverlayDD.h.

void casa::SkyCatOverlayDD::destructParameters ( ) [private]

virtual Bool casa::SkyCatOverlayDD::determineDirectionColumnMapping ( ) [protected, virtual]

Attempt to determine which columns map to longitude, latitude, and type.

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

Implements casa::DisplayData.

Definition at line 158 of file SkyCatOverlayDD.h.

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

Retrieve the current and default options and parameter types.

Reimplemented from casa::PassiveTableDD.

virtual Float casa::SkyCatOverlayDD::labelXOffset ( ) const [inline, virtual]

Get the label x and y offsets (in character height).

Definition at line 146 of file SkyCatOverlayDD.h.

References itsParamLabelXOffset, and casa::DParameterRange< T >::value().

virtual Float casa::SkyCatOverlayDD::labelYOffset ( ) const [inline, virtual]

Definition at line 149 of file SkyCatOverlayDD.h.

References itsParamLabelYOffset, and casa::DParameterRange< T >::value().

virtual Float casa::SkyCatOverlayDD::lineWidth ( ) const [inline, virtual]

Get the line width for labelling.

Definition at line 106 of file SkyCatOverlayDD.h.

References itsParamLineWidth, and casa::DParameterRange< T >::value().

virtual String casa::SkyCatOverlayDD::mapColumn ( ) const [inline, virtual]

Get the column name for value-size mapping.

Definition at line 123 of file SkyCatOverlayDD.h.

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

virtual String casa::SkyCatOverlayDD::markerColor ( ) const [inline, virtual]

Definition at line 118 of file SkyCatOverlayDD.h.

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

virtual Int casa::SkyCatOverlayDD::markerSize ( ) const [inline, virtual]

Definition at line 115 of file SkyCatOverlayDD.h.

References itsParamMarkerSize, and casa::DParameterRange< T >::value().

virtual Display::Marker casa::SkyCatOverlayDD::markerType ( ) const [inline, virtual]

Get the marker type, size and color.

Definition at line 112 of file SkyCatOverlayDD.h.

References itsParamMarkerType, and casa::DParameterMapKeyChoice::keyValue().

virtual String casa::SkyCatOverlayDD::nameColumn ( ) const [inline, virtual]

Get the column name for text labelling.

Definition at line 101 of file SkyCatOverlayDD.h.

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

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

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

(Required) copy assignment.

Reimplemented from casa::PassiveTableDD.

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

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::PassiveTableDD.

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

Install the default options for this DisplayData.

Reimplemented from casa::PassiveTableDD.

virtual Bool casa::SkyCatOverlayDD::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::PassiveTableDD.