CSIM: FilterFunction Class Reference

FilterFunction Class Reference

#include <filterfunction.h>

Inheritance diagram for FilterFunction:

List of all members.

Detailed Description

Base class of all filter objects.

Public Member Functions

FilterFunction (void)
virtual void setParameter (string name, double value)
virtual int advance (void)
Dummy implementation.
virtual int addIncoming (Advancable *Incoming)
This method will be called if object Incoming wants to send information to this object.
virtual int addOutgoing (Advancable *Outgoing)
This method will be called if this object wants to send information to object Outgoing.
virtual double getParameter (string name)
virtual list< string > validParameters (void)
virtual void reset ()=0
virtual int updateInternal ()

Protected Attributes

map< string, double * > params

Constructor & Destructor Documentation

FilterFunction::FilterFunction ( void )

Initializes a new filter.

Member Function Documentation

double FilterFunction::getParameter ( string name ) [virtual]

Returns the current value of a parameter.
Parameters:

name Name of the parameter.

Returns:
The value of the parameter.

virtual void FilterFunction::reset ( ) [pure virtual]

Resets the information stored within the filter.
Implements Advancable.
Implemented in AnalogFilter, and SpikeFilter.

void FilterFunction::setParameter ( string name,

double value

) [virtual]

Sets a parameter of the filter function.
Parameters:

name Name of the parameter.

value Value to set for the parameter.

virtual int FilterFunction::updateInternal ( void ) [inline, virtual]

This function is called after parameters are updated.
Reimplemented from csimClass.
Reimplemented in AlphaSpikeFilter, AnalogFilter, CountSpikeFilter, ExpSpikeFilter, and UserAnalogFilter.

list< string > FilterFunction::validParameters ( void ) [virtual]

Returns the names of the valid parameters.
Returns:
A string list indicating the valid parameter names.

Member Data Documentation

map<string, double *> FilterFunction::params [protected]

A map storing pointers to the parameters.

last modified 07/10/2006