FrequencySweep Class Reference

#include <FrequencySweep.hh>

Collaboration diagram for FrequencySweep:

Public Member Functions
	FrequencySweep (int startMHz, int endMHz, int stepMHz)
virtual	~FrequencySweep ()
int	nextFrequency ()

Private Attributes
int	nextFrequency_
	Next frequency to be returned.
bool	hasNext_
	Flag indicating is there next frequency to return.
int	endMHz_
	End frequency.
int	stepMHz_
	Step frequency.

Detailed Description

Sweeps through the frequencies from lowest frequency towards the highest frequency and returns all step frequencies including the start and end frequency.

FrequencySweep takes start and and frequencies and a step frequency that tells how big frequency steps are taken between the start and end point.

Definition at line 47 of file FrequencySweep.hh.

Constructor & Destructor Documentation

FrequencySweep()

FrequencySweep::FrequencySweep	(	int	startMHz,
		int	endMHz,
		int	stepMHz
	)

Constructor of the FrequencySweep.

Parameters

startMHz	Start frequency in MHz.
endMHz	End frequency in MHz.
stepMHz	Stepping frequency in MHz.

Exceptions

IllegalParameters

Throws if the frequencies are smaller than one.

Definition at line 43 of file FrequencySweep.cc.

    : hasNext_(true), endMHz_(endMHz), stepMHz_(stepMHz) {
    // Sweep is always done from the lowest frequency towards the highest
    // frequency.
    if (startMHz > endMHz) {
        int tempMHz = startMHz;
        startMHz = endMHz;
        endMHz = tempMHz;
    }
    
    if (startMHz < 1 || stepMHz < 1) {
        std::string message = "Parameter value lower than one.";
        throw IllegalParameters(__FILE__, __LINE__, __func__, message);
    }
    nextFrequency_ = startMHz;
}

References __func__, and nextFrequency_.

~FrequencySweep()

FrequencySweep::~FrequencySweep ( )

virtual

The destructor.

Definition at line 63 of file FrequencySweep.cc.

                                {
}

Member Function Documentation

nextFrequency()

int FrequencySweep::nextFrequency

(

)

Returns the next frequency or zero if all steps have been returned and steps forward.

Returns

Next frequency of zero if all steps have been returned.

Definition at line 73 of file FrequencySweep.cc.

                              {
 
    if (hasNext_ == false) {
        return 0;
    }
    int current = nextFrequency_;
    nextFrequency_ = current + stepMHz_;
    if (nextFrequency_ > endMHz_) {
        nextFrequency_ = endMHz_;
        if (current == nextFrequency_) {
            hasNext_ = false;
        }
    }
    return current;
}

References endMHz_, hasNext_, nextFrequency_, and stepMHz_.

Referenced by FrequencySweepExplorer::explore().

Member Data Documentation

endMHz_

int FrequencySweep::endMHz_

private

End frequency.

Definition at line 59 of file FrequencySweep.hh.

Referenced by nextFrequency().

hasNext_

bool FrequencySweep::hasNext_

private

Flag indicating is there next frequency to return.

Definition at line 57 of file FrequencySweep.hh.

Referenced by nextFrequency().

nextFrequency_

int FrequencySweep::nextFrequency_

private

Next frequency to be returned.

Definition at line 55 of file FrequencySweep.hh.

Referenced by FrequencySweep(), and nextFrequency().

stepMHz_

int FrequencySweep::stepMHz_

private

Step frequency.

Definition at line 61 of file FrequencySweep.hh.

Referenced by nextFrequency().

---

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

• FrequencySweep.hh
• FrequencySweep.cc