casa::Iterate Class Reference

Base class for Iteration. More...

#include <Iterate.h>

Inheritance diagram for casa::Iterate:

List of all members.

Public Member Functions
	Iterate ()
	Constructor.
virtual	~Iterate ()
void	setFree ()
	Is this a free variable?
void	setNotFree ()
Bool	free ()
void	setNumberIterations (const Int n)
void	setGain (const Float g)
void	setTolerance (const Float t)
void	setThreshold (const Float t)
void	setMode (const String m)
Int	numberIterations ()
Float	gain ()
Float	tolerance ()
virtual Float	threshold ()
const String	mode ()
Private Attributes
Int	numberIterations_
Double	gain_
Double	tolerance_
Double	threshold_
Bool	free_
String	mode_

---

Detailed Description

Base class for Iteration.

Definition at line 40 of file Iterate.h.

---

Constructor & Destructor Documentation

casa::Iterate::Iterate

(

)

[inline]

Constructor.

Definition at line 43 of file Iterate.h.

virtual casa::Iterate::~Iterate

(

)

[inline, virtual]

Definition at line 46 of file Iterate.h.

---

Member Function Documentation

Bool casa::Iterate::free

(

)

[inline]

Definition at line 53 of file Iterate.h.

References free_.

Float casa::Iterate::gain

(

)

[inline]

Definition at line 63 of file Iterate.h.

References gain_.

const String casa::Iterate::mode

(

)

[inline]

Definition at line 66 of file Iterate.h.

Int casa::Iterate::numberIterations

(

)

[inline]

Definition at line 62 of file Iterate.h.

References numberIterations_.

Referenced by casa::ClarkCleanLatModel::getNumberIterations().

void casa::Iterate::setFree

(

)

[inline]

Is this a free variable?

Definition at line 49 of file Iterate.h.

References free_, and casacore::True.

void casa::Iterate::setGain

(

const Float

g

)

[inline]

Definition at line 57 of file Iterate.h.

References gain_.

void casa::Iterate::setMode

(

const String

m

)

[inline]

Definition at line 60 of file Iterate.h.

References mode_.

void casa::Iterate::setNotFree

(

)

[inline]

Definition at line 51 of file Iterate.h.

References casacore::False, and free_.

void casa::Iterate::setNumberIterations

(

const Int

n

)

[inline]

Definition at line 56 of file Iterate.h.

References numberIterations_.

void casa::Iterate::setThreshold

(

const Float

t

)

[inline]

Definition at line 59 of file Iterate.h.

References threshold_.

void casa::Iterate::setTolerance

(

const Float

t

)

[inline]

Definition at line 58 of file Iterate.h.

References tolerance_.

virtual Float casa::Iterate::threshold

(

)

[inline, virtual]

Reimplemented in casa::ClarkCleanModel.

Definition at line 65 of file Iterate.h.

References threshold_.

Float casa::Iterate::tolerance

(

)

[inline]

Definition at line 64 of file Iterate.h.

References tolerance_.

---

Member Data Documentation

Bool casa::Iterate::free_ [private]

Definition at line 73 of file Iterate.h.

Referenced by free(), setFree(), and setNotFree().

Double casa::Iterate::gain_ [private]

Definition at line 70 of file Iterate.h.

Referenced by gain(), and setGain().

String casa::Iterate::mode_ [private]

Definition at line 74 of file Iterate.h.

Referenced by setMode().

Int casa::Iterate::numberIterations_ [private]

Definition at line 66 of file Iterate.h.

Referenced by numberIterations(), and setNumberIterations().

Double casa::Iterate::threshold_ [private]

Definition at line 72 of file Iterate.h.

Referenced by setThreshold(), and threshold().

Double casa::Iterate::tolerance_ [private]

Definition at line 71 of file Iterate.h.

Referenced by setTolerance(), and tolerance().

---

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

• code/synthesis/MeasurementEquations/Iterate.h