SkyCatOverlayDD.h

Classes

SkyCatOverlayDD -- Simple implementation of a cached DisplayData for sky catalogue overlays. (full description)

class SkyCatOverlayDD : public PassiveTableDD

Interface

Public Members
SkyCatOverlayDD(Table* table)
SkyCatOverlayDD(const String tablename)
virtual ~SkyCatOverlayDD()
virtual void setDefaultOptions()
virtual Bool setOptions(Record &rec, Record &recOut)
virtual Record getOptions()
virtual Display::DisplayDataType classType()
virtual CachingDisplayMethod* newDisplayMethod(WorldCanvas* worldCanvas, AttributeBuffer* wchAttributes, AttributeBuffer* ddAttributes, CachingDisplayData* dd)
virtual AttributeBuffer optionsAsAttributes()
virtual String nameColumn() const
virtual Float lineWidth() const
virtual Display::Marker markerType() const
virtual Int markerSize() const
virtual String markerColor() const
virtual String mapColumn() const
virtual String charFont() const
virtual Float charSize() const
virtual String charColor() const
virtual Int charAngle() const
virtual Float labelXOffset() const
virtual Float labelYOffset() const
virtual Bool conformsToCS(const WorldCanvasHolder& wch)
Protected Members
SkyCatOverlayDD()
SkyCatOverlayDD(const SkyCatOverlayDD &other)
void operator=(const SkyCatOverlayDD &other)
virtual Bool determineDirectionColumnMapping()
Unit columnUnit(const String columnName) const
Private Members
void constructParameters()
void destructParameters()

Description

Member Description

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. 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.

virtual Record getOptions()

Retrieve the current and default options and parameter types.

virtual Display::DisplayDataType classType()

Return the type of this 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. The tag is a unique number used to identify the age of the newly constructed CachingDisplayMethod.

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
virtual Int markerSize() const
virtual String markerColor() const

Get the marker type, size and color.

virtual String mapColumn() const

Get the column name for value-size mapping.

virtual String charFont() const
virtual Float charSize() const
virtual String charColor() const
virtual Int charAngle() const

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

virtual Float labelXOffset() const
virtual Float labelYOffset() const

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

virtual Bool conformsToCS(const WorldCanvasHolder& wch)

Determine ability to draw, given current canvas coordinate state. This DD requires direction coordinates in both X and Y axis codes.

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. 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.

void constructParameters()
void destructParameters()

Construct and destruct the parameter set.