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.
	ColormapInfo (const Colormap *colormap, const Float &weight, const uInt &offset, const uInt &size)
	Constructor taking a pointer to a Colormap, and the initial weight, offset and size of the Colormap.
const Colormap *	colormap () const
	Yield a pointer to the Colormap about which this stores information.
Float	weight () const
	Return the current weight for this mapping.
uInt	offset () const
	Return the current offset for this mapping.
uInt	size () const
	Return the current size for this mapping.
void	setWeight (const Float &weight)
	Set the weight for this mapping.
void	setOffset (const uInt &offset)
	Set the offset for this mapping.
void	setSize (const uInt &size)
	Set the size for this mapping.
void	ref ()
	Increment and decrement the reference count for this mapping.
void	unref ()
uInt	refCount () const
	Return the current reference count.
Private Attributes
const Colormap *	itsColormap
	Store the Colormap of this mapping here.
Float	itsWeight
	Store the weight of the mapping here.
uInt	itsOffset
	Store the offset of the mapping here.
uInt	itsSize
	Store the size of the mapping here.
Int	itsRefCount
	Store the reference count of the mapping here.

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 Float &	weight,
		const uInt &	offset,
		const 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.

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.

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 uInt & offset )

Set the offset for this mapping.

void casa::ColormapInfo::setSize ( const uInt & size )

Set the size for this mapping.

void casa::ColormapInfo::setWeight ( const Float & weight )

Set the weight for this mapping.

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 ( )

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

uInt casa::ColormapInfo::itsOffset [private]

Store the offset of the mapping here.

Definition at line 112 of file ColormapInfo.h.

Referenced by offset().

Int casa::ColormapInfo::itsRefCount [private]

Store the reference count of the mapping here.

Definition at line 118 of file ColormapInfo.h.

Referenced by refCount().

uInt casa::ColormapInfo::itsSize [private]

Store the size of the mapping here.

Definition at line 115 of file ColormapInfo.h.

Referenced by size().

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:

code/display/Display/ColormapInfo.h