casa::ColormapInfo Class Reference

ColormapInfo stores information about the dynamic mapping of a Colormap. More...

#include <ColormapInfo.h>

Public Member Functions
	ColormapInfo ()
	(Required) default constructor. More...
	ColormapInfo (const Colormap *colormap, const casacore::Float &weight, const casacore::uInt &offset, const casacore::uInt &size)
	Constructor taking a pointer to a Colormap, and the initial weight, offset and size of the Colormap. More...
const Colormap *	colormap () const
	Yield a pointer to the Colormap about which this stores information. More...
casacore::Float	weight () const
	Return the current weight for this mapping. More...
casacore::uInt	offset () const
	Return the current offset for this mapping. More...
casacore::uInt	size () const
	Return the current size for this mapping. More...
void	setWeight (const casacore::Float &weight)
	Set the weight for this mapping. More...
void	setOffset (const casacore::uInt &offset)
	Set the offset for this mapping. More...
void	setSize (const casacore::uInt &size)
	Set the size for this mapping. More...
void	ref ()
	Increment and decrement the reference count for this mapping. More...
void	unref ()
casacore::uInt	refCount () const
	Return the current reference count. More...

Private Attributes
const Colormap *	itsColormap
	Store the Colormap of this mapping here. More...
casacore::Float	itsWeight
	Store the weight of the mapping here. More...
casacore::uInt	itsOffset
	Store the offset of the mapping here. More...
casacore::uInt	itsSize
	Store the size of the mapping here. More...
casacore::Int	itsRefCount
	Store the reference count of the mapping here. More...

Detailed Description

ColormapInfo stores information about the dynamic mapping of a Colormap.

Synopsis

Motivation

Example

Definition at line 50 of file ColormapInfo.h.

Constructor & Destructor Documentation

casa::ColormapInfo::ColormapInfo

(

)

(Required) default constructor.

casa::ColormapInfo::ColormapInfo	(	const Colormap *	colormap,
		const casacore::Float &	weight,
		const casacore::uInt &	offset,
		const casacore::uInt &	size
	)

Constructor taking a pointer to a Colormap, and the initial weight, offset and size of the Colormap.

Member Function Documentation

const Colormap* casa::ColormapInfo::colormap ( ) const

inline

Yield a pointer to the Colormap about which this stores information.

Definition at line 64 of file ColormapInfo.h.

References itsColormap.

casacore::uInt casa::ColormapInfo::offset ( ) const

inline

Return the current offset for this mapping.

Definition at line 74 of file ColormapInfo.h.

References itsOffset.

void casa::ColormapInfo::ref

(

)

Increment and decrement the reference count for this mapping.

casacore::uInt casa::ColormapInfo::refCount ( ) const

inline

Return the current reference count.

Definition at line 99 of file ColormapInfo.h.

References itsRefCount.

void casa::ColormapInfo::setOffset

(

const casacore::uInt &

offset

)

Set the offset for this mapping.

void casa::ColormapInfo::setSize

(

const casacore::uInt &

size

)

Set the size for this mapping.

void casa::ColormapInfo::setWeight

(

const casacore::Float &

weight

)

Set the weight for this mapping.

casacore::uInt casa::ColormapInfo::size ( ) const

inline

Return the current size for this mapping.

Definition at line 79 of file ColormapInfo.h.

References itsSize.

void casa::ColormapInfo::unref

(

)

casacore::Float casa::ColormapInfo::weight ( ) const

inline

Return the current weight for this mapping.

Definition at line 69 of file ColormapInfo.h.

References itsWeight.

Member Data Documentation

const Colormap* casa::ColormapInfo::itsColormap

private

Store the Colormap of this mapping here.

Definition at line 106 of file ColormapInfo.h.

Referenced by colormap().

casacore::uInt casa::ColormapInfo::itsOffset

private

Store the offset of the mapping here.

Definition at line 112 of file ColormapInfo.h.

Referenced by offset().

casacore::Int casa::ColormapInfo::itsRefCount

private

Store the reference count of the mapping here.

Definition at line 118 of file ColormapInfo.h.

Referenced by refCount().

casacore::uInt casa::ColormapInfo::itsSize

private

Store the size of the mapping here.

Definition at line 115 of file ColormapInfo.h.

Referenced by size().

casacore::Float casa::ColormapInfo::itsWeight

private

Store the weight of the mapping here.

Definition at line 109 of file ColormapInfo.h.

Referenced by weight().

---

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

• casa/code/display/Display/ColormapInfo.h