carma::control::Harmonic Class Reference

An LOchain harmonic; has self consistent ref and yig frequencies and harmonics. More...

#include <carma/control/LOchain.h>

Public Member Functions
int	getRank () const
	Get the rank for this harmonic (1 is best, 2 is second best, etc) More...
Freq	getRefFreq () const
	Get the ref frequency. More...
int	getRefHarmonicNumber () const
	Get the ref harmonic number. More...
double	getTuningRange () const
	Get the fractional tuning range. More...
double	getTuningScore () const
	Get the score for this harmonic (range is [0,10) More...
Freq	getYigFreq () const
	Get the yig frequency. More...
int	getYigHarmonicNumber () const
	Get the yig harmonic number. More...
	Harmonic ()
	Constructor. More...
void	setRank (int rank)
	Set the rank. More...
void	setRefFreq (const Freq &ref)
	Set the ref frequency. More...
void	setRefHarmonicNumber (int harm)
	Set the harmonic number. More...
void	setTuningRange (double range)
	Set the tuning range. More...
void	setTuningScore (double score)
	Set the tuning score. More...
void	setYigFreq (const Freq &yig)
	Set the yig frequency. More...
void	setYigHarmonicNumber (int harm)
	Set the yig harmonic number. More...

Detailed Description

An LOchain harmonic; has self consistent ref and yig frequencies and harmonics.

Definition at line 107 of file LOchain.h.

Constructor & Destructor Documentation

carma::control::Harmonic::Harmonic

(

)

Constructor.

Member Function Documentation

int carma::control::Harmonic::getRank

(

)

const

Get the rank for this harmonic (1 is best, 2 is second best, etc)

Freq carma::control::Harmonic::getRefFreq

(

)

const

Get the ref frequency.

int carma::control::Harmonic::getRefHarmonicNumber

(

)

const

Get the ref harmonic number.

double carma::control::Harmonic::getTuningRange

(

)

const

Get the fractional tuning range.

double carma::control::Harmonic::getTuningScore

(

)

const

Get the score for this harmonic (range is [0,10)

Freq carma::control::Harmonic::getYigFreq

(

)

const

Get the yig frequency.

int carma::control::Harmonic::getYigHarmonicNumber

(

)

const

Get the yig harmonic number.

void carma::control::Harmonic::setRank

(

int

rank

)

Set the rank.

Parameters

rank	of this tuning

void carma::control::Harmonic::setRefFreq

(

const Freq &

ref

)

Set the ref frequency.

Parameters

ref

frequency

void carma::control::Harmonic::setRefHarmonicNumber

(

int

harm

)

Set the harmonic number.

Parameters

harm	harmonic number

void carma::control::Harmonic::setTuningRange

(

double

range

)

Set the tuning range.

Parameters

range

absolute fractional tuning range

void carma::control::Harmonic::setTuningScore

(

double

score

)

Set the tuning score.

Parameters

score

of this tuning

void carma::control::Harmonic::setYigFreq

(

const Freq &

yig

)

Set the yig frequency.

Parameters

yig

frequency

void carma::control::Harmonic::setYigHarmonicNumber

(

int

harm

)

Set the yig harmonic number.

Parameters

harm	harmonic number

---

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

• carma/control/LOchain.h