Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

scaled_real_parameter Class Reference

A scaled parameter is a fixed factor times another parameter. More...

#include <scaled_real_parameter.h>

Inheritance diagram for scaled_real_parameter::

abstract_real_parameter List of all members.

Public Methods

 scaled_real_parameter ()
 scaled_real_parameter (const double s, abstract_real_parameter &p)
void set (const double s, abstract_real_parameter &p)
 Set up shadowing and the scaling factor. More...

double get () const
 Get the value of this parameter. More...


Private Attributes

abstract_real_parametershadowed
 The parameter we are a fixed factor times. More...

double scale
 The scaling factor. More...

int get_flag
 A flag to avoid possible infinite self-referential loops of shadowed parameters. More...


Detailed Description

A scaled parameter is a fixed factor times another parameter.

Definition at line 48 of file scaled_real_parameter.h.


Constructor & Destructor Documentation

scaled_real_parameter::scaled_real_parameter ( )
 

Definition at line 37 of file scaled_real_parameter.cc.

scaled_real_parameter::scaled_real_parameter ( const double s,
abstract_real_parameter & p )
 

Parameters:
s   the scaling factor to be multiplied by p
p   the parameter to be shadowed and scaled

Definition at line 43 of file scaled_real_parameter.cc.


Member Function Documentation

double scaled_real_parameter::get ( ) const [virtual]
 

Get the value of this parameter.

Returns:
the value of this parameter

Reimplemented from abstract_real_parameter.

Definition at line 49 of file scaled_real_parameter.cc.

void scaled_real_parameter::set ( const double s,
abstract_real_parameter & p )
 

Set up shadowing and the scaling factor.

Parameters:
s   the scaling factor to be multiplied by p
p   the parameter to be shadowed and scaled

Definition at line 75 of file scaled_real_parameter.cc.

Referenced by mixer_currents::set_harmonic().


Member Data Documentation

int scaled_real_parameter::get_flag [mutable, private]
 

A flag to avoid possible infinite self-referential loops of shadowed parameters.

Definition at line 61 of file scaled_real_parameter.h.

double scaled_real_parameter::scale [private]
 

The scaling factor.

Definition at line 55 of file scaled_real_parameter.h.

abstract_real_parameter * scaled_real_parameter::shadowed [private]
 

The parameter we are a fixed factor times.

Definition at line 52 of file scaled_real_parameter.h.


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

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by doxygen1.2.7