Parameters Class Reference

Brief description of class still missing. More...

#include <Parameters.h>

Inheritance diagram for Parameters:

List of all members.

Public Member Functions
virtual void	collectKeywords (PARAMETERS_COLLECTKEYWORDS_ARGS)
FilterParameters &	filter ()
const FilterParameters &	filter () const
const double &	fitLength () const
bool	isFilter () const
virtual int	keywordCount (PARAMETERS_KEYWORDCOUNT_ARGS)
	Parameters ()
	Parameters (const Parameters &o)
void	setFilter (const FilterParameters &f)
void	setFitLength (const double &f)
void	setTimeRange (const TimeRangeParameters &t)
virtual bool	setValue (PARAMETERS_SETVALUE_ARGS)
void	setWindowLength (const double &w)
TimeRangeParameters &	timeRange ()
const TimeRangeParameters &	timeRange () const
virtual QString	toString (PARAMETERS_TOSTRING_ARGS_DECL) const
const double &	windowLength () const
	~Parameters ()

---

Detailed Description

Brief description of class still missing.

Full description of class still missing

---

Constructor & Destructor Documentation

Parameters::Parameters

(

)

Description of constructor still missing

  : AbstractParameters()
{
  _filter=0;
}

Parameters::Parameters

(

const Parameters &

o

)

Description of constructor still missing

  : AbstractParameters()
{
  if(o._filter) {
    _filter=new FilterParameters(*o._filter);
  } else {
    _filter=0;
  }
}

Parameters::~Parameters

(

)

Description of destructor still missing

{
  delete _filter;
}

---

Member Function Documentation

void Parameters::collectKeywords

(

PARAMETERS_COLLECTKEYWORDS_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References GeopsyCore::FilterParameters::collectKeywords(), GeopsyCore::TimeRangeParameters::collectKeywords(), isFilter(), and TRACE.

{
  TRACE;
  keywords.add(prefix+"DO FILTER", this, 0);
  keywords.add(prefix+"WINDOW LENGTH", this, 1);
  keywords.add(prefix+"FIT LENGTH", this, 2);
  _timeRange.collectKeywords(keywords, prefix);
  if(isFilter()) {
    _filter->collectKeywords(keywords, prefix);
  }
}

FilterParameters & Parameters::filter

(

)

References TRACE.

Referenced by DampingResults::compute(), ToolDampingd::getParameters(), and ToolDampingd::setParameters().

{
  TRACE;
  if(!_filter) {
    _filter=new FilterParameters;
  }
  return *_filter;
}

const FilterParameters & Parameters::filter

(

)

const

References TRACE.

{
  TRACE;
  ASSERT(_filter);
  return *_filter;
}

const double& Parameters::fitLength

(

)

const [inline]

Referenced by DampingResults::compute(), and ToolDampingd::setParameters().

{return _fitLength;}

bool Parameters::isFilter

(

)

const [inline]

Referenced by collectKeywords(), DampingResults::compute(), ToolDampingd::setParameters(), and toString().

{return _filter;}

int Parameters::keywordCount

(

PARAMETERS_KEYWORDCOUNT_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

{
  return 3;
}

void Parameters::setFilter

(

const FilterParameters &

f

)

References TRACE.

{
  TRACE;
  if(_filter) {
    *_filter=f;
  } else {
    _filter=new FilterParameters(f);
  }
}

void Parameters::setFitLength

(

const double &

f

)

[inline]

Referenced by ToolDampingd::getParameters().

{_fitLength=f;}

void Parameters::setTimeRange

(

const TimeRangeParameters &

t

)

[inline]

{_timeRange=t;}

bool Parameters::setValue

(

PARAMETERS_SETVALUE_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References TRACE.

{
  TRACE;
  switch(index) {
  case 0:
    if(value=="y" ||
       value=="true") {  // For compatibility
      if(!_filter) {
        _filter=new FilterParameters;
      }
    }
    return true;
  case 1:
    _windowLength=value.toDouble();
    return true;
  case 2:
    _fitLength=value.toDouble();
    return true;
  default:
    return false;
  }
}

void Parameters::setWindowLength

(

const double &

w

)

[inline]

Referenced by ToolDampingd::getParameters().

{_windowLength=w;}

TimeRangeParameters& Parameters::timeRange

(

)

[inline]

Referenced by DampingResults::compute(), ToolDampingd::getParameters(), and ToolDampingd::setParameters().

{return _timeRange;}

const TimeRangeParameters& Parameters::timeRange

(

)

const [inline]

{return _timeRange;}

QString Parameters::toString

(

PARAMETERS_TOSTRING_ARGS_DECL

)

const [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

References isFilter(), QGpCoreTools::log(), GeopsyCore::FilterParameters::toString(), GeopsyCore::TimeRangeParameters::toString(), and TRACE.

Referenced by DampingResults::compute().

{
  TRACE;
  QString log;
  if(isFilter()) {
    log+=prefix+"DO FILTER=y\n";
    log+=_filter->toString(prefix);
  } else {
    log+=prefix+"DO FILTER=n\n";
  }
  log+=_timeRange.toString(prefix);
  log+="WINDOW LENGTH="+QString::number(_windowLength)+"\n";
  log+="FIT LENGTH="+QString::number(_fitLength)+"\n";
  return log;
}

const double& Parameters::windowLength

(

)

const [inline]

Referenced by DampingResults::compute(), and ToolDampingd::setParameters().

{return _windowLength;}

---

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

• geopsydamping/Parameters.h
• geopsydamping/Parameters.cpp