Isis::QStretch Class Reference

Abstract class for complex stretch objects. More...

#include <QStretch.h>

Inheritance diagram for Isis::QStretch:

[legend]

Collaboration diagram for Isis::QStretch:

[legend]

List of all members.

Signals
void	update ()
	Signal to emit when this QStretch has been updated.
Public Member Functions
	QStretch (const StretchTool *stretchTool, QString name)
	QStretch Constructor.
virtual QStretch *	clone ()=0
	Abstract method to clone a QStretch in order to retain its parameters and stretch pairs.
virtual void	connectTable (QTableWidget *widget)
	Abstract method to connect the AdvancedStretchTool's table of stretch pairs in order to modify it if necessary.
virtual void	disconnectTable (QTableWidget *widget)
	Abstract method to disconnect the AdvancedStretchTool's table of stretch pairs.
virtual QGroupBox *	getParameters ()=0
	Abstract method to return a QGroupBox of this QStretch's parameters.
QString	name ()
	This method returns the name of this QStretch.
Stretch	stretch ()
	This method returns the stretch.
virtual void	setMinMax (double min, double max)
	Abstract method to set the minimum and maximum values that stretch input pairs can be set to.
Protected Attributes
const StretchTool *	p_stretchTool
	The StretchTool that created this QStretch.
QString	p_name
	The name of this QStretch.
double	p_min
	The minimum value a stretch input pair can be set to.
double	p_max
	The maximum value a stretch input pair can be set to.
QGroupBox *	p_parametersBox
	The QGroupBox that holds this QStretch's parameters.
Stretch	p_stretch
	The stretch that this QStretch modifies.

Detailed Description

Abstract class for complex stretch objects.

This class serves as the parent class to complex stretch objects that are used by the AdvancedStretchTool. It must define parameters to manipulate its stretch pairs that will be used by the AdvancedStretchTool's 'Advanced' dialog.

Author:: 2009-05-01 Noah hilt

For internal use only.

Definition at line 26 of file QStretch.h.

Constructor & Destructor Documentation

Isis::QStretch::QStretch	(	const StretchTool *	stretchTool,
		QString	name
	)			`[inline]`

QStretch Constructor.

StretchTool can not be null.

Initializes the stretch and sets its special pixel values to their defaults.

Parameters:

	stretchTool
	name

Definition at line 39 of file QStretch.h.

References p_stretch, Isis::Stretch::SetHis(), Isis::Stretch::SetHrs(), Isis::Stretch::SetLis(), Isis::Stretch::SetLrs(), and Isis::Stretch::SetNull().

Member Function Documentation

virtual QStretch* Isis::QStretch::clone ( ) [pure virtual]

Abstract method to clone a QStretch in order to retain its parameters and stretch pairs.

This method must be overridden.

Returns:: QStretch*

virtual void Isis::QStretch::connectTable ( QTableWidget * widget ) [inline, virtual]

Abstract method to connect the AdvancedStretchTool's table of stretch pairs in order to modify it if necessary.

The default implementation is to do nothing.

Parameters:

widget

Definition at line 71 of file QStretch.h.

virtual void Isis::QStretch::disconnectTable ( QTableWidget * widget ) [inline, virtual]

Abstract method to disconnect the AdvancedStretchTool's table of stretch pairs.

The default implementation is to do nothing.

Parameters:

widget

Definition at line 79 of file QStretch.h.

virtual QGroupBox* Isis::QStretch::getParameters ( ) [pure virtual]

Abstract method to return a QGroupBox of this QStretch's parameters.

This method must be overridden.

Returns:: QGroupBox*

QString Isis::QStretch::name ( ) [inline]

This method returns the name of this QStretch.

Returns:: QString

Definition at line 96 of file QStretch.h.

References p_name.

virtual void Isis::QStretch::setMinMax	(	double	min,
		double	max
	)			`[inline, virtual]`

Abstract method to set the minimum and maximum values that stretch input pairs can be set to.

Parameters:

	min
	max

Definition at line 117 of file QStretch.h.

References p_max, and p_min.

Stretch Isis::QStretch::stretch ( ) [inline]

This method returns the stretch.

Returns:: Stretch

Definition at line 106 of file QStretch.h.

References p_stretch.

void Isis::QStretch::update ( ) [signal]

Signal to emit when this QStretch has been updated.

Member Data Documentation

double Isis::QStretch::p_max [protected]

The maximum value a stretch input pair can be set to.

Definition at line 132 of file QStretch.h.

Referenced by setMinMax().

double Isis::QStretch::p_min [protected]

The minimum value a stretch input pair can be set to.

Definition at line 131 of file QStretch.h.

Referenced by setMinMax().

QString Isis::QStretch::p_name [protected]

The name of this QStretch.

Definition at line 130 of file QStretch.h.

Referenced by name().

QGroupBox* Isis::QStretch::p_parametersBox [protected]

The QGroupBox that holds this QStretch's parameters.

Definition at line 133 of file QStretch.h.

Stretch Isis::QStretch::p_stretch [protected]

The stretch that this QStretch modifies.

Definition at line 134 of file QStretch.h.

Referenced by QStretch(), and stretch().

const StretchTool* Isis::QStretch::p_stretchTool [protected]

The StretchTool that created this QStretch.

Definition at line 129 of file QStretch.h.

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

src/qisis/objs/StretchTool/QStretch.h

Isis::QStretch Class Reference

Signals

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation