DiffAmp Class Reference

#include <DiffAmp.h>

Collaboration diagram for DiffAmp:

Public Member Functions
	DiffAmp ()
double	getGain () const
double	getOutput () const
double	getSaturation () const
void	minusFunc (double input)
void	plusFunc (double input)
void	process (const Eref &e, ProcPtr p)
void	reinit (const Eref &e, ProcPtr p)
void	setGain (double gain)
void	setSaturation (double saturation)
	~DiffAmp ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

Protected Attributes
double	gain_
double	minus_
double	output_
double	plus_
double	saturation_

Detailed Description

Definition at line 36 of file DiffAmp.h.

Constructor & Destructor Documentation

DiffAmp::DiffAmp

(

)

Definition at line 147 of file DiffAmp.cpp.

                :gain_(1.0), saturation_(DBL_MAX), plus_(0), minus_(0), output_(0)
{
}

DiffAmp::~DiffAmp

(

)

Definition at line 150 of file DiffAmp.cpp.

                 {
    ;
}

Member Function Documentation

double DiffAmp::getGain

(

)

const

Definition at line 173 of file DiffAmp.cpp.

References gain_.

Referenced by initCinfo().

{
    return gain_;
}

Here is the caller graph for this function:

double DiffAmp::getOutput

(

)

const

Definition at line 183 of file DiffAmp.cpp.

References output_.

Referenced by initCinfo().

{
    return output_;
}

Here is the caller graph for this function:

double DiffAmp::getSaturation

(

)

const

Definition at line 178 of file DiffAmp.cpp.

References saturation_.

Referenced by initCinfo().

{
    return saturation_;
}

Here is the caller graph for this function:

const Cinfo * DiffAmp::initCinfo ( )

static

Definition at line 51 of file DiffAmp.cpp.

References diffAmpCinfo, getGain(), getOutput(), getSaturation(), Neutral::initCinfo(), minusFunc(), output(), outputOut(), plusFunc(), process(), reinit(), setGain(), and setSaturation().

{
    static ValueFinfo<DiffAmp, double> gain( "gain",
                                             "Gain of the amplifier. The output of the amplifier is the difference"
                                             " between the totals in plus and minus inputs multiplied by the"
                                             " gain. Defaults to 1" ,
                                             &DiffAmp::setGain,
                                             &DiffAmp::getGain);
    static ValueFinfo<DiffAmp, double > saturation( "saturation",
                                                    "Saturation is the bound on the output. If output goes beyond the +/-"
                                                    "saturation range, it is truncated to the closer of +saturation and"
                                                    " -saturation. Defaults to the maximum double precision floating point"
                                                    " number representable on the system." ,
                                                    &DiffAmp::setSaturation,
                                                    &DiffAmp::getSaturation);

    static ReadOnlyValueFinfo<DiffAmp, double> output( "outputValue",
                                               "Output of the amplifier, i.e. gain * (plus - minus)." ,
                                               &DiffAmp::getOutput);
    // Dest messages

    static DestFinfo gainIn( "gainIn",
                             "Destination message to control gain dynamically.",
                             new OpFunc1<DiffAmp, double> (&DiffAmp::setGain));

    static DestFinfo plusIn( "plusIn",
                      "Positive input terminal of the amplifier. All the messages connected"
                      " here are summed up to get total positive input.",
                      new OpFunc1<DiffAmp, double> (&DiffAmp::plusFunc));

    static DestFinfo minusIn( "minusIn",
                      "Negative input terminal of the amplifier. All the messages connected"
                      " here are summed up to get total positive input.",
                      new OpFunc1<DiffAmp, double> (&DiffAmp::minusFunc));
    // Shared messages
    static DestFinfo process( "process",
                              "Handles process call, updates internal time stamp.",
                              new ProcOpFunc< DiffAmp >( &DiffAmp::process ) );
    static DestFinfo reinit( "reinit",
                             "Handles reinit call.",
                             new ProcOpFunc< DiffAmp >( &DiffAmp::reinit ) );
    static Finfo* processShared[] =
            {
        &process, &reinit
            };

    static SharedFinfo proc( "proc",
                             "This is a shared message to receive Process messages "
                             "from the scheduler objects."
                             "The first entry in the shared msg is a MsgDest "
                             "for the Process operation. It has a single argument, "
                             "ProcInfo, which holds lots of information about current "
                             "time, thread, dt and so on. The second entry is a MsgDest "
                             "for the Reinit operation. It also uses ProcInfo. ",
                             processShared, sizeof( processShared ) / sizeof( Finfo* )
                             );


    static Finfo * diffAmpFinfos[] = {
        &gain,
        &saturation,
        &output,
        &gainIn,
        &plusIn,
        &minusIn,
        outputOut(),
        &proc
    };
    static string doc[] = {
        "Name", "DiffAmp",
        "Author", "Subhasis Ray, 2008, NCBS",
        "Description", "A difference amplifier. "
        "Output is the difference between the total plus inputs and the total "
        "minus inputs multiplied by gain. Gain can be set statically as a field"
        " or can be a destination message and thus dynamically determined by the"
        " output of another object. Same as GENESIS diffamp object."
    };
    static Dinfo<DiffAmp> dinfo;
    static Cinfo diffAmpCinfo(
            "DiffAmp",
            Neutral::initCinfo(),
            diffAmpFinfos,
            sizeof(diffAmpFinfos)/sizeof(Finfo*),
            &dinfo,
            doc,
            sizeof(doc)/sizeof(string)
);

    return &diffAmpCinfo;
}

Here is the call graph for this function:

void DiffAmp::minusFunc

(

double

input

)

Definition at line 158 of file DiffAmp.cpp.

References minus_.

Referenced by initCinfo().

{
    minus_ += input;
}

Here is the caller graph for this function:

void DiffAmp::plusFunc

(

double

input

)

Definition at line 153 of file DiffAmp.cpp.

References plus_.

Referenced by initCinfo().

{
    plus_ += input;
}

Here is the caller graph for this function:

void DiffAmp::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 188 of file DiffAmp.cpp.

References gain_, minus_, output(), output_, outputOut(), plus_, and saturation_.

Referenced by initCinfo().

{
    double output = gain_ * (plus_ - minus_);
    plus_ = 0.0;
    minus_ = 0.0;
    if ( output > saturation_ ) {
    output = saturation_;
    }
    if ( output < -saturation_ ) {
    output = -saturation_;
    }
    output_ = output;
    outputOut()->send(e, output_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void DiffAmp::reinit	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 203 of file DiffAmp.cpp.

References minus_, output_, outputOut(), and plus_.

Referenced by initCinfo().

{
    // What is the right thing to do?? Should we actually do a process step??
    output_ = 0.0;
    plus_ = 0.0;
    minus_ = 0.0;
    outputOut()->send(e, output_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void DiffAmp::setGain

(

double

gain

)

Definition at line 163 of file DiffAmp.cpp.

References gain_.

Referenced by initCinfo().

{
    gain_ = gain;
}

Here is the caller graph for this function:

void DiffAmp::setSaturation

(

double

saturation

)

Definition at line 168 of file DiffAmp.cpp.

References saturation_.

Referenced by initCinfo().

{
    saturation_ = saturation;
}

Here is the caller graph for this function:

Member Data Documentation

double DiffAmp::gain_

protected

Definition at line 54 of file DiffAmp.h.

Referenced by getGain(), process(), and setGain().

double DiffAmp::minus_

protected

Definition at line 57 of file DiffAmp.h.

Referenced by minusFunc(), process(), and reinit().

double DiffAmp::output_

protected

Definition at line 58 of file DiffAmp.h.

Referenced by getOutput(), process(), and reinit().

double DiffAmp::plus_

protected

Definition at line 56 of file DiffAmp.h.

Referenced by plusFunc(), process(), and reinit().

double DiffAmp::saturation_

protected

Definition at line 55 of file DiffAmp.h.

Referenced by getSaturation(), process(), and setSaturation().

---

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

• moose-core/device/DiffAmp.h
• moose-core/device/DiffAmp.cpp