casa::AnnSymbol Class Reference

Represents a symbol annotation. More...

#include <AnnSymbol.h>

Inheritance diagram for casa::AnnSymbol:

List of all members.

Public Types
enum	Symbol {   POINT,   PIXEL,   CIRCLE,   TRIANGLE_DOWN,   TRIANGLE_UP,   TRIANGLE_LEFT,   TRIANGLE_RIGHT,   TRI_DOWN,   TRI_UP,   TRI_LEFT,   TRI_RIGHT,   SQUARE,   PENTAGON,   STAR,   HEXAGON1,   HEXAGON2,   PLUS,   X,   DIAMOND,   THIN_DIAMOND,   VLINE,   HLINE,   UNKNOWN }
	allowed symbols More...
Public Member Functions
	AnnSymbol (const Quantity &x, const Quantity &y, const String &dirRefFrameString, const CoordinateSystem &csys, const Char symbolChar, const Quantity &beginFreq, const Quantity &endFreq, const String &freqRefFrame, const String &dopplerString, const Quantity &restfreq, const Vector< Stokes::StokesTypes > &stokes)
	AnnSymbol (const Quantity &x, const Quantity &y, const CoordinateSystem &csys, const Symbol symbol, const Vector< Stokes::StokesTypes > &stokes)
AnnSymbol &	operator= (const AnnSymbol &other)
	implicit copy constructor and destructor are fine
MDirection	getDirection () const
Symbol	getSymbol () const
virtual ostream &	print (ostream &os) const
Static Public Member Functions
static Symbol	charToSymbol (const Char c)
static Char	symbolToChar (const Symbol s)
Private Member Functions
void	_init (const Quantity &x, const Quantity &y)
Static Private Member Functions
static void	_initMap ()
Private Attributes
AnnotationBase::Direction	_inputDirection
Symbol	_symbol
Char	_symbolChar
Static Private Attributes
static const String	_class
static map< Char, Symbol >	_symbolMap

---

Detailed Description

Represents a symbol annotation.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Synopsis

Represents an ascii symbol annotation

Definition at line 47 of file AnnSymbol.h.

---

Member Enumeration Documentation

enum casa::AnnSymbol::Symbol

allowed symbols

Enumerator:

POINT
PIXEL
CIRCLE
TRIANGLE_DOWN
TRIANGLE_UP
TRIANGLE_LEFT
TRIANGLE_RIGHT
TRI_DOWN
TRI_UP
TRI_LEFT
TRI_RIGHT
SQUARE
PENTAGON
STAR
HEXAGON1
HEXAGON2
PLUS
X
DIAMOND
THIN_DIAMOND
VLINE
HLINE
UNKNOWN

Definition at line 51 of file AnnSymbol.h.

---

Constructor & Destructor Documentation

casa::AnnSymbol::AnnSymbol	(	const Quantity &	x,
		const Quantity &	y,
		const String &	dirRefFrameString,
		const CoordinateSystem &	csys,
		const Char	symbolChar,
		const Quantity &	beginFreq,
		const Quantity &	endFreq,
		const String &	freqRefFrame,
		const String &	dopplerString,
		const Quantity &	restfreq,
		const Vector< Stokes::StokesTypes > &	stokes
	)

casa::AnnSymbol::AnnSymbol	(	const Quantity &	x,
		const Quantity &	y,
		const CoordinateSystem &	csys,
		const Symbol	symbol,
		const Vector< Stokes::StokesTypes > &	stokes
	)

---

Member Function Documentation

void casa::AnnSymbol::_init	(	const Quantity &	x,
		const Quantity &	y
	)			[private]

static void casa::AnnSymbol::_initMap

(

)

[static, private]

static Symbol casa::AnnSymbol::charToSymbol

(

const Char

c

)

[static]

MDirection casa::AnnSymbol::getDirection

(

)

const

Symbol casa::AnnSymbol::getSymbol

(

)

const

AnnSymbol& casa::AnnSymbol::operator=

(

const AnnSymbol &

other

)

implicit copy constructor and destructor are fine

Reimplemented from casa::AnnotationBase.

virtual ostream& casa::AnnSymbol::print

(

ostream &

os

)

const [virtual]

Implements casa::AnnotationBase.

static Char casa::AnnSymbol::symbolToChar

(

const Symbol

s

)

[static]

---

Member Data Documentation

const String casa::AnnSymbol::_class [static, private]

Reimplemented from casa::AnnotationBase.

Definition at line 115 of file AnnSymbol.h.

AnnotationBase::Direction casa::AnnSymbol::_inputDirection [private]

Definition at line 112 of file AnnSymbol.h.

Symbol casa::AnnSymbol::_symbol [private]

Definition at line 113 of file AnnSymbol.h.

Char casa::AnnSymbol::_symbolChar [private]

Definition at line 114 of file AnnSymbol.h.

map<Char, Symbol> casa::AnnSymbol::_symbolMap [static, private]

Definition at line 116 of file AnnSymbol.h.

---

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

• code/imageanalysis/Annotations/AnnSymbol.h