ArrayCore::ArrayParameters Class Reference

Brief description of class still missing. More...

#include <ArrayParameters.h>

Inheritance diagram for ArrayCore::ArrayParameters:

List of all members.

Public Member Functions
	ArrayParameters ()
	ArrayParameters (const ArrayParameters &o)
virtual void	collectKeywords (PARAMETERS_COLLECTKEYWORDS_ARGS)
double	frequencyBandWidth () const
SamplingParameters &	frequencySampling ()
const SamplingParameters &	frequencySampling () const
virtual int	keywordCount (PARAMETERS_KEYWORDCOUNT_ARGS)
const QString &	outputFile () const
void	setFrequencyBandWidth (double f)
void	setFrequencySampling (const SamplingParameters &f)
void	setOutputFile (const QString &o)
void	setTimeLimits (const TimeRangeParameters &t)
virtual bool	setValue (PARAMETERS_SETVALUE_ARGS)
void	setWindowing (const WindowingParameters &w)
TimeRangeParameters &	timeLimits ()
const TimeRangeParameters &	timeLimits () const
virtual QString	toString (PARAMETERS_TOSTRING_ARGS_DECL) const
WindowingParameters &	windowing ()
const WindowingParameters &	windowing () const

---

Detailed Description

Brief description of class still missing.

Full description of class still missing

---

Constructor & Destructor Documentation

ArrayCore::ArrayParameters::ArrayParameters

(

)

  {
    _frequencyBandWidth=0.1;
  }

ArrayCore::ArrayParameters::ArrayParameters

(

const ArrayParameters &

o

)

    : _timeLimits(o._timeLimits),
      _windowing(o._windowing),
      _frequencySampling(o._frequencySampling),
      _outputFile(o._outputFile)
  {
    _frequencyBandWidth=o._frequencyBandWidth;
  }

---

Member Function Documentation

void ArrayCore::ArrayParameters::collectKeywords

(

PARAMETERS_COLLECTKEYWORDS_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

Reimplemented in ArrayCore::FKParameters, ArrayCore::SPACParameters, and ArrayCore::HRFKParameters.

References QGpCoreTools::SamplingParameters::collectKeywords(), GeopsyCore::TimeRangeParameters::collectKeywords(), GeopsyCore::WindowingParameters::collectKeywords(), and TRACE.

  {
    TRACE;
    keywords.add(prefix+"FREQ BAND WIDTH", this, 0);
    keywords.add(prefix+"OUTPUT FILE", this, 1);
    _timeLimits.collectKeywords(keywords, prefix);
    _windowing.collectKeywords(keywords, prefix);
    _frequencySampling.collectKeywords(keywords, prefix);
  }

double ArrayCore::ArrayParameters::frequencyBandWidth

(

)

const [inline]

Referenced by ToolFK::checkParameters(), ToolFKd::setParameters(), and ArrayCore::ArrayProcess::setParameters().

{return _frequencyBandWidth;}

SamplingParameters& ArrayCore::ArrayParameters::frequencySampling

(

)

[inline]

Referenced by ToolLinearFKPassive::finishPositive(), ToolSPACd::getParameters(), ToolFKd::getParameters(), ArrayCore::ArrayProcess::setFrequency(), ToolFKd::setParameters(), ToolSPAC::startLoop(), and ToolFK::startLoop().

{return _frequencySampling;}

const SamplingParameters& ArrayCore::ArrayParameters::frequencySampling

(

)

const [inline]

{return _frequencySampling;}

int ArrayCore::ArrayParameters::keywordCount

(

PARAMETERS_KEYWORDCOUNT_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

Reimplemented in ArrayCore::FKParameters, ArrayCore::SPACParameters, and ArrayCore::HRFKParameters.

Referenced by ArrayCore::HRFKParameters::setValue(), ArrayCore::SPACParameters::setValue(), and ArrayCore::FKParameters::setValue().

  {
    return 2;
  }

const QString& ArrayCore::ArrayParameters::outputFile

(

)

const [inline]

Referenced by ToolFK::finish(), ArrayCore::SPACParameters::overWrite(), FKLoop::setParameters(), SPACLoop::setParameters(), ToolSPAC::startLoop(), ToolFK::startLoop(), and SPACLoop::~SPACLoop().

{return _outputFile;}

void ArrayCore::ArrayParameters::setFrequencyBandWidth

(

double

f

)

[inline]

Referenced by ToolSPACd::getParameters(), and ToolFKd::getParameters().

{_frequencyBandWidth=f;}

void ArrayCore::ArrayParameters::setFrequencySampling

(

const SamplingParameters &

f

)

[inline]

{_frequencySampling=f;}

void ArrayCore::ArrayParameters::setOutputFile

(

const QString &

o

)

[inline]

Referenced by ToolSPACd::getParameters(), ToolLinearFKPassive::start(), ToolHRFK::start(), and ToolFK::start().

{_outputFile=o;}

void ArrayCore::ArrayParameters::setTimeLimits

(

const TimeRangeParameters &

t

)

[inline]

{_timeLimits=t;}

bool ArrayCore::ArrayParameters::setValue

(

PARAMETERS_SETVALUE_ARGS

)

[virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

Reimplemented in ArrayCore::FKParameters, ArrayCore::SPACParameters, and ArrayCore::HRFKParameters.

References TRACE.

  {
    TRACE;
    switch(index) {
    case 0:
      _frequencyBandWidth=value.toDouble();
      return true;
    case 1:
      _outputFile=value;
      return true;
    default:
      return false;
    }
  }

void ArrayCore::ArrayParameters::setWindowing

(

const WindowingParameters &

w

)

[inline]

{_windowing=w;}

TimeRangeParameters& ArrayCore::ArrayParameters::timeLimits

(

)

[inline]

Referenced by ToolSPACd::getParameters(), ToolFKd::getParameters(), and ToolFKd::setParameters().

{return _timeLimits;}

const TimeRangeParameters& ArrayCore::ArrayParameters::timeLimits

(

)

const [inline]

{return _timeLimits;}

QString ArrayCore::ArrayParameters::toString

(

PARAMETERS_TOSTRING_ARGS_DECL

)

const [virtual]

Reimplemented from QGpCoreTools::AbstractParameters.

Reimplemented in ArrayCore::FKParameters, ArrayCore::SPACParameters, and ArrayCore::HRFKParameters.

References QGpCoreTools::log(), QGpCoreTools::SamplingParameters::toString(), GeopsyCore::TimeRangeParameters::toString(), GeopsyCore::WindowingParameters::toString(), and TRACE.

  {
    TRACE;
    QString log;
    log+=_timeLimits.toString(prefix);
    log+=_windowing.toString(prefix);
    log+=_frequencySampling.toString(prefix);
    log+=prefix+"FREQ BAND WIDTH="+QString::number(_frequencyBandWidth)+"\n";
    log+=prefix+"OUTPUT FILE="+_outputFile+"\n";
    return log;
  }

WindowingParameters& ArrayCore::ArrayParameters::windowing

(

)

[inline]

Referenced by ToolSPACd::getParameters(), ToolFKd::getParameters(), ArrayCore::ArrayProcess::setFrequency(), and ToolFKd::setParameters().

{return _windowing;}

const WindowingParameters& ArrayCore::ArrayParameters::windowing

(

)

const [inline]

{return _windowing;}

---

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

• ArrayCore/ArrayParameters.h
• ArrayCore/ArrayParameters.cpp