Relacs  0.9.8
Public Types | Public Member Functions | List of all members
Filter Class Reference

#include <filter.h>

Inheritance diagram for Filter:
Inheritance graph
[legend]
Collaboration diagram for Filter:
Collaboration graph
[legend]

Public Types

enum  FilterType {
  SingleAnalogFilter =0, MultipleAnalogFilter =1, SingleEventFilter =2, MultipleEventFilter =3,
  SingleAnalogDetector =4, MultipleAnalogDetector =5, SingleEventDetector =6, MultipleEventDetector =7,
  MultipleTraces =1, EventInput =2, EventDetector =4
}
 
- Public Types inherited from ConfigClass
enum  Action { Save =1, Dialog =2, Help =4, Menu =8 }
 
- Public Types inherited from Options
enum  SaveFlags {
  NoName = 1, NoType = 2, NoInclude = 4, SwitchNameType = 8,
  Embrace = 16, PrintRequest = 32, FirstOnly = 64, PrintType = 128,
  PrintStyle = 256, DontCloseSection = 512, AlwaysQuote = 1024, EscapeQuotes = 2048
}
 
typedef deque< Parameter >
::iterator 
iterator
 
typedef deque< Parameter >
::const_iterator 
const_iterator
 
typedef deque< Options * >
::iterator 
section_iterator
 
typedef deque< Options * >
::const_iterator 
const_section_iterator
 

Public Member Functions

 Filter (const string &ident, int mode, FilterType type, int outtraces=0, const string &name="", const string &pluginset="", const string &author="unknown", const string &version="unknown", const string &date=__DATE__)
 
virtual ~Filter (void)
 
virtual int init (const InData &indata, InData &outdata)
 
virtual int init (const InList &indata, InList &outdata)
 
virtual int init (const EventData &inevents, InData &outdata)
 
virtual int init (const EventList &inevents, InList &outdata)
 
virtual int init (const InData &indata, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const InList &indata, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int adjust (const InData &indata, InData &outdata)
 
virtual int adjust (const InList &indata, InList &outdata)
 
virtual int adjust (const EventData &inevents, InData &outdata)
 
virtual int adjust (const EventList &inevents, InList &outdata)
 
virtual int adjust (const InData &indata)
 
virtual int adjust (const InList &indata)
 
virtual int adjust (const EventData &inevents)
 
virtual int adjust (const EventList &inevents)
 
virtual int autoConfigure (const InData &indata, double tbegin, double tend)
 
virtual int autoConfigure (const InList &indata, double tbegin, double tend)
 
virtual int autoConfigure (const EventData &inevents, double tbegin, double tend)
 
virtual int autoConfigure (const EventList &inevents, double tbegin, double tend)
 
virtual int filter (const InData &indata, InData &outdata)
 
virtual int filter (const InList &indata, InList &outdata)
 
virtual int filter (const EventData &inevents, InData &outdata)
 
virtual int filter (const EventList &inevents, InList &outdata)
 
virtual int detect (const InData &data, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const InList &data, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual void save (const string &param)
 
void save (void)
 
const string & ident (void) const
 
virtual void setIdent (const string &ident)
 
virtual void setName (const string &name)
 
FilterType type (void) const
 
int outTraces (void) const
 
int mode (void) const
 
void setMode (int mode)
 
- Public Member Functions inherited from RELACSPlugin
 RELACSPlugin (const string &configident="", int configgroup=0, const string &name="", const string &pluginset="", const string &author="unknown", const string &version="unknown", const string &date=__DATE__)
 
virtual ~RELACSPlugin (void)
 
QWidget * widget (void)
 
void setWidget (QWidget *widget)
 
void setLayout (QLayout *layout)
 
int desktopWidth (void) const
 
int desktopHeight (void) const
 
string pluginSet (void) const
 
string uniqueName (void) const
 
void setShortUniqueName (void)
 
void setLongUniqueName (void)
 
void updateUniqueName (void)
 
const Optionssettings (void) const
 
Optionssettings (void)
 
void setSettings (void)
 
virtual void modeChanged (void)
 
virtual void notifyMetaData (void)
 
virtual void notifyStimulusData (void)
 
void setRELACSWidget (RELACSWidget *rw)
 
virtual string helpFileName (void) const
 
const InListtraces (void) const
 
const InDatatrace (int index) const
 
const InDatatrace (const string &ident) const
 
int traceIndex (const string &ident) const
 
string traceNames (void) const
 
string rawTraceNames (void) const
 
const EventListevents (void) const
 
const EventDataevents (int index) const
 
const EventDataevents (const string &ident) const
 
const EventDatastimulusEvents (void) const
 
const EventDatarestartEvents (void) const
 
const EventDatarecordingEvents (void) const
 
int traceInputTrace (int trace) const
 
int traceInputTrace (const string &ident) const
 
int traceInputEvent (int trace) const
 
int traceInputEvent (const string &ident) const
 
int eventInputTrace (int event) const
 
int eventInputTrace (const string &ident) const
 
int eventInputEvent (int event) const
 
int eventInputEvent (const string &ident) const
 
double signalTime (void) const
 
double currentTime (void) const
 
double currentTimeRaw (void) const
 
void addTracesEvents (deque< InList * > &data, deque< EventList * > &events)
 
void setTracesEvents (const InList &data, const EventList &event)
 
void assignTracesEvents (const InList &data, const EventList &events)
 
void assignTracesEvents (void)
 
void updateDerivedTracesEvents (void)
 
int getData (double mintracetime=0.0, double prevsignal=-1000.0)
 
int outTracesSize (void) const
 
int outTraceIndex (const string &name) const
 
string outTraceName (int index) const
 
string outTraceNames (void) const
 
const TraceSpecoutTrace (int index) const
 
const TraceSpecoutTrace (const string &name) const
 
void setSignalDelay (int device, double delay)
 
bool acquisition (void) const
 
bool simulation (void) const
 
bool analysis (void) const
 
bool idle (void) const
 
string modeStr (void) const
 
OptionsrelacsSettings (void)
 
const OptionsrelacsSettings (void) const
 
void lockRelacsSettings (void) const
 
void unlockRelacsSettings (void) const
 
QMutex * relacsSettingsMutex (void)
 
string path (void) const
 
string addPath (const string &file) const
 
string defaultPath (void) const
 
string addDefaultPath (const string &file) const
 
bool saving (void) const
 
OptionsstimulusData (void)
 
const OptionsstimulusData (void) const
 
int stimulusDataTraceFlag (void) const
 
void lockStimulusData (void) const
 
void unlockStimulusData (void) const
 
QMutex * stimulusDataMutex (void)
 
MetaDatametaData (void)
 
const MetaDatametaData (void) const
 
void lockMetaData (void) const
 
void unlockMetaData (void) const
 
QMutex * metaDataMutex (void)
 
AllDevicesdevices (void) const
 
Devicedevice (const string &ident)
 
void updateDeviceMenu (void)
 
DigitalIOdigitalIO (const string &ident)
 
Triggertrigger (const string &ident)
 
Attenuateattenuator (const string &name)
 
Filterfilter (const string &name)
 
FilterfilterTrace (int index)
 
FilterfilterTrace (const string &name)
 
OptionsfilterOpts (const string &name)
 
OptionsfilterTraceOpts (int index)
 
OptionsfilterTraceOpts (const string &name)
 
void lockFilter (const string &name)
 
void lockFilterTrace (int index)
 
void lockFilterTrace (const string &name)
 
void unlockFilter (const string &name)
 
void unlockFilterTrace (int index)
 
void unlockFilterTrace (const string &name)
 
void autoConfigureFilter (Filter *filter, double tbegin, double tend)
 
void autoConfigureFilter (Filter *filter, double duration)
 
void autoConfigureFilter (double tbegin, double tend)
 
void autoConfigureFilter (double duration)
 
Filterdetector (const string &name)
 
FilterdetectorEvents (int index)
 
FilterdetectorEvents (const string &name)
 
OptionsdetectorOpts (const string &name)
 
OptionsdetectorEventsOpts (int index)
 
OptionsdetectorEventsOpts (const string &name)
 
void lockDetector (const string &name)
 
void lockDetectorEvents (int index)
 
void lockDetectorEvents (const string &name)
 
void unlockDetector (const string &name)
 
void unlockDetectorEvents (int index)
 
void unlockDetectorEvents (const string &name)
 
void autoConfigureDetector (Filter *detector, double tbegin, double tend)
 
void autoConfigureDetector (Filter *detector, double duration)
 
void autoConfigureDetectors (double tbegin, double tend)
 
void autoConfigureDetectors (double duration)
 
double sessionTime (void) const
 
string sessionTimeStr (void) const
 
bool sessionRunning (void) const
 
int reproCount (void) const
 
virtual void sessionStarted (void)
 
virtual void sessionStopped (bool saved)
 
bool globalKeyEvents (void)
 
void setGlobalKeyEvents (bool global=true)
 
- Public Member Functions inherited from ConfigDialog
 ConfigDialog (const string &configident="", int configgroup=0, const string &name="", const string &author="", const string &version="", const string &date=__DATE__)
 
virtual ~ConfigDialog (void)
 
string name (void) const
 
string author (void) const
 
virtual void setAuthor (const string &author)
 
string version (void) const
 
virtual void setVersion (const string &version)
 
string date (void) const
 
virtual void setDate (const string &date)
 
virtual OptWidgetdialogOptions (OptDialog *od, string *tabhotkeys=0)
 
virtual void dialogButtons (OptDialog *od)
 
virtual void dialogEmptyMessage (OptDialog *od)
 
int dialogSelectMask (void) const
 
void setDialogSelectMask (int mask)
 
void addDialogSelectMask (int mask)
 
int dialogReadOnlyMask (void) const
 
void setDialogReadOnlyMask (int mask)
 
void addDialogReadOnlyMask (int mask)
 
int dialogStyle (void) const
 
void setDialogStyle (int style)
 
void addDialogStyle (int style)
 
string dialogCaption (void) const
 
void setDialogCaption (const string &caption)
 
bool dialogHeader (void) const
 
void setDialogHeader (bool d)
 
string headerBackgroundColor (void) const
 
void setHeaderBackgroundColor (const string &color)
 
string headerForegroundColor (void) const
 
void setHeaderForegroundColor (const string &color)
 
string headerImageFile (void) const
 
void setHeaderImageFile (const string &file)
 
virtual void dialogHeaderWidget (OptDialog *od)
 
bool dialogHelp (void) const
 
void setDialogHelp (bool d)
 
string helpCaption (void) const
 
void setHelpCaption (const string &caption)
 
string helpPath (int inx=0) const
 
int helpPathes (void) const
 
void clearHelpPathes (void)
 
void setHelpPath (const string &path)
 
void addHelpPath (const string &path)
 
bool dialogOpen (void) const
 
bool helpOpen (void) const
 
QWidget * mainWidget (void)
 
virtual void setMainWidget (QWidget *widget)
 
void lock () const
 
void unlock () const
 
bool tryLock (int timeout=1)
 
QMutex * mutex (void)
 
- Public Member Functions inherited from ConfigClass
 ConfigClass (const string &ident, int group=0, int mode=0xffff, int selectmask=0)
 
 ConfigClass (const ConfigClass &C)
 
virtual ~ConfigClass (void)
 
const string & configIdent (void) const
 
void setConfigIdent (const string &ident)
 
int configGroup (void) const
 
void setConfigGroup (int group)
 
int configMode (void) const
 
void setConfigMode (int mode)
 
void addConfigMode (int mode)
 
void delConfigMode (int mode)
 
int configSelectMask (void) const
 
void setConfigSelectMask (int mask)
 
void addConfig (void)
 
void readConfig (void)
 
virtual void readConfig (StrQueue &sq)
 
virtual void saveConfig (ofstream &str)
 
virtual int configSize (void) const
 
virtual void config (void)
 
virtual void preConfig (void)
 
- Public Member Functions inherited from Options
 Options (void)
 
 Options (const Options &o)
 
 Options (const Options &o, int flags)
 
 Options (const string &name, const string &type, int flags, int style)
 
 Options (const Str &opttxt, const string &assignment=":=", const string &separator=",;")
 
 Options (const StrQueue &sq, const string &assignment=":=")
 
 Options (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
 
virtual ~Options (void)
 
Optionsoperator= (const Options &o)
 
Optionsassign (const Options &o)
 
Optionsappend (const Options &o)
 
Optionsadd (const Options &o)
 
Optionsinsert (const Options &o, const string &atname="")
 
Optionsassign (const Options &o, int flags)
 
Optionscopy (Options &o, int flags)
 
Optionsappend (const Options &o, int flags)
 
Optionsadd (const Options &o, int flags)
 
Optionsinsert (const Options &o, int flags, const string &atname="")
 
Parameterassign (const string &name, const string &value)
 
OptionsparentSection (void)
 
const OptionsparentSection (void) const
 
void setParentSection (Options *parentsection)
 
void resetParents (void)
 
OptionsrootSection (void)
 
const OptionsrootSection (void) const
 
string name (void) const
 
virtual void setName (const string &name, const string &type)
 
string type (void) const
 
void setType (const string &type)
 
string include (void) const
 
void setInclude (const string &include)
 
void setInclude (const string &url, const string &name)
 
int flag (void) const
 
bool flag (int selectflag) const
 
OptionssetFlag (int flag)
 
OptionsaddFlag (int flag)
 
OptionsdelFlag (int flag)
 
OptionsclearFlag (void)
 
int style (void) const
 
OptionssetStyle (int style)
 
OptionsaddStyle (int style)
 
OptionsdelStyle (int style)
 
OptionsclearStyle (void)
 
bool checkType (int mask) const
 
Str warning (void) const
 
iterator begin (void)
 
iterator end (void)
 
const_iterator begin (void) const
 
const_iterator end (void) const
 
section_iterator sectionsBegin (void)
 
section_iterator sectionsEnd (void)
 
const_section_iterator sectionsBegin (void) const
 
const_section_iterator sectionsEnd (void) const
 
const_iterator find (const string &pattern, int level=-1) const
 
iterator find (const string &pattern, int level=-1)
 
const_iterator rfind (const string &pattern, int level=-1) const
 
iterator rfind (const string &pattern, int level=-1)
 
const_section_iterator findSection (const string &pattern, int level=-1) const
 
section_iterator findSection (const string &pattern, int level=-1)
 
const_section_iterator rfindSection (const string &pattern, int level=-1) const
 
section_iterator rfindSection (const string &pattern, int level=-1)
 
const Parameteroperator[] (int i) const
 
Parameteroperator[] (int i)
 
const Parameteroperator[] (const string &name) const
 
Parameteroperator[] (const string &name)
 
const Optionssection (int i) const
 
Optionssection (int i)
 
const Optionssection (const string &name) const
 
Optionssection (const string &name)
 
Str request (const string &name) const
 
ParametersetRequest (const string &name, const string &request)
 
Parameter::ValueType valueType (const string &name) const
 
ParametersetValueType (const string &name, Parameter::ValueType type)
 
int flags (const string &name) const
 
bool flags (const string &name, int flag) const
 
ParametersetFlags (const string &name, int flags)
 
ParameteraddFlags (const string &name, int flags)
 
ParameterdelFlags (const string &name, int flags)
 
ParameterclearFlags (const string &name)
 
bool changed (const string &name)
 
int style (const string &name) const
 
ParametersetStyle (const string &name, int style)
 
ParameteraddStyle (const string &name, int style)
 
ParameterdelStyle (const string &name, int style)
 
Str format (const string &name) const
 
ParametersetFormat (const string &name, int width=0, int prec=-1, char fmt='g')
 
ParametersetFormat (const string &name, const string &format)
 
int formatWidth (const string &name) const
 
int size (const string &name) const
 
Parameteradd (const Parameter &np)
 
Parameterinsert (const Parameter &np, const string &atname="")
 
ParameteraddText (const string &name, const string &request, const string &dflt, int flags=0, int style=0)
 
ParameteraddText (const string &name, const string &dflt="", int flags=0, int style=0)
 
ParameterinsertText (const string &name, const string &atname, const string &request, const string &dflt, int flags=0, int style=0)
 
ParameterinsertText (const string &name, const string &atname="", const string &dflt="", int flags=0, int style=0)
 
Str text (const string &name, int index, const string &dflt="", const string &format="", const string &unit="") const
 
Str text (const string &name, const string &dflt="", const string &format="", const string &unit="") const
 
void texts (const string &name, vector< string > &s, const string &format="", const string &unit="") const
 
Str allText (const string &name, const string &dflt="", const string &format="", const string &unit="", const string &separator=", ") const
 
ParametersetText (const string &name, const string &strg)
 
ParametersetText (const string &name, const Parameter &p)
 
ParameterpushText (const string &name, const string &strg)
 
Str defaultText (const string &name, const string &format="", const string &unit="") const
 
ParametersetDefaultText (const string &name, const string &dflt)
 
ParameteraddSelection (const string &name, const string &request, const string &selection, int flags=0, int style=0)
 
ParameteraddSelection (const string &name, const string &selection="", int flags=0, int style=0)
 
ParameterinsertSelection (const string &name, const string &atname, const string &request, const string &selection, int flags=0, int style=0)
 
ParameterinsertSelection (const string &name, const string &atname="", const string &selection="", int flags=0, int style=0)
 
ParameterselectText (const string &name, const string &strg, int add=0)
 
ParameterselectText (const string &name, int index)
 
int index (const string &name) const
 
int index (const string &name, const string &strg) const
 
ParameteraddNumber (const string &name, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
 
ParameteraddNumber (const string &name, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameteraddNumber (const string &name, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameteraddNumber (const string &name, double dflt, const string &unit, int flags, int style=0)
 
ParameteraddNumber (const string &name, double dflt, double error, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameteraddNumber (const string &name, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameterinsertNumber (const string &name, const string &atname, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
 
ParameterinsertNumber (const string &name, const string &atname, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameterinsertNumber (const string &name, const string &atname, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
ParameterinsertNumber (const string &name, const string &atname, const string &unit="", const string &format="", int flags=0, int style=0)
 
double number (const string &name, double dflt=0.0, const string &unit="", int index=0) const
 
double number (const string &name, const string &unit, double dflt=0.0, int index=0) const
 
double number (const string &name, int index, double dflt=0.0, const string &unit="") const
 
double number (const string &name, int index, const string &unit, double dflt=0.0) const
 
void numbers (const string &name, vector< double > &n, const string &unit="") const
 
double error (const string &name, const string &unit="", int index=0) const
 
double error (const string &name, int index, const string &unit="") const
 
void errors (const string &name, vector< double > &n, const string &unit="") const
 
ParametersetNumber (const string &name, double number, double error, const string &unit="")
 
ParametersetNumber (const string &name, double number, const string &unit="")
 
ParameterpushNumber (const string &name, double number, double error=-1.0, const string &unit="")
 
ParameterpushNumber (const string &name, double number, const string &unit)
 
ParametersetNumber (const string &name, const Parameter &p)
 
double defaultNumber (const string &name, const string &unit="") const
 
ParametersetDefaultNumber (const string &name, double dflt, const string &unit="")
 
double minimum (const string &name, const string &unit="") const
 
double maximum (const string &name, const string &unit="") const
 
double step (const string &name, const string &unit="") const
 
ParametersetStep (const string &name, double step, const string &unit="")
 
ParametersetMinMax (const string &name, double minimum=-MAXDOUBLE, double maximum=MAXDOUBLE, double step=1.0, const string &unit="")
 
Str unit (const string &name) const
 
Str outUnit (const string &name) const
 
ParametersetUnit (const string &name, const string &internunit, const string &outunit="")
 
ParametersetOutUnit (const string &name, const string &outputunit)
 
ParameterchangeUnit (const string &name, const string &internunit)
 
ParameteraddInteger (const string &name, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
 
ParameteraddInteger (const string &name, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
 
ParameteraddInteger (const string &name, const string &unit="")
 
ParameterinsertInteger (const string &name, const string &atname, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
 
ParameterinsertInteger (const string &name, const string &atname, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
 
ParameterinsertInteger (const string &name, const string &atname, const string &unit="", int width=0, int flags=0, int style=0)
 
long integer (const string &name, const string &unit="", long dflt=0, int index=0) const
 
long integer (const string &name, int index, long dflt=0, const string &unit="") const
 
long integer (const string &name, int index, const string &unit, long dflt=0) const
 
void integers (const string &name, vector< long > &n, const string &unit="") const
 
void integers (const string &name, vector< int > &n, const string &unit="") const
 
ParametersetInteger (const string &name, long number, long error, const string &unit="")
 
ParametersetInteger (const string &name, long number, const string &unit="")
 
ParameterpushInteger (const string &name, long number, long error, const string &unit="")
 
ParameterpushInteger (const string &name, long number, const string &unit="")
 
ParametersetInteger (const string &name, const Parameter &p)
 
long defaultInteger (const string &name, const string &unit="") const
 
ParametersetDefaultInteger (const string &name, long dflt, const string &unit="")
 
ParametersetMinMax (const string &name, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="")
 
ParametersetMinMax (const string &name, int minimum, int maximum, int step=1, const string &unit="")
 
ParameteraddBoolean (const string &name, const string &request, bool dflt, int flags=0, int style=0)
 
ParameteraddBoolean (const char *name, const char *request, bool dflt, int flags=0, int style=0)
 
ParameteraddBoolean (const string &name, bool dflt, int flags=0, int style=0)
 
ParameteraddBoolean (const char *name, bool dflt, int flags=0, int style=0)
 
ParameterinsertBoolean (const string &name, const string &atname="", const string &request="", bool dflt=false, int flags=0, int style=0)
 
ParameterinsertBoolean (const string &name, const string &atname, int flags=0, int style=0)
 
bool boolean (const string &name, bool dflt=false, int index=0) const
 
bool boolean (const string &name, int index, bool dflt=false) const
 
void booleans (const string &name, vector< bool > &n) const
 
ParametersetBoolean (const string &name, bool b)
 
ParametersetBoolean (const string &name, const Parameter &p)
 
bool defaultBoolean (const string &name) const
 
ParametersetDefaultBoolean (const string &name, bool dflt)
 
ParameteraddDate (const string &name, const string &request, int year=0, int month=0, int day=0, int flags=0, int style=0)
 
ParameteraddDate (const string &name, int year, int month, int day, int flags=0, int style=0)
 
ParameteraddDate (const string &name, int flags=0, int style=0)
 
ParameterinsertDate (const string &name, const string &atname="", const string &request="", int year=0, int month=0, int day=0, int flags=0, int style=0)
 
ParameterinsertDate (const string &name, const string &atname, int year=0, int month=0, int day=0, int flags=0, int style=0)
 
ParameterinsertDate (const string &name, const string &atname, int flags=0, int style=0)
 
const Parameterdate (const string &name, int index, int &year, int &month, int &day) const
 
ParametersetDate (const string &name, int year, int month, int day)
 
ParametersetDate (const string &name, const string &date)
 
ParametersetDate (const string &name, const struct tm &date)
 
ParametersetDate (const string &name, const time_t &time)
 
ParametersetCurrentDate (const string &name)
 
ParametersetDate (const string &name, const Parameter &p)
 
const ParameterdefaultDate (const string &name, int index, int &year, int &month, int &day) const
 
ParametersetDefaultDate (const string &name, int year, int month, int day)
 
ParameteraddTime (const string &name, const string &request, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
 
ParameteraddTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0, int flags=0, int style=0)
 
ParameteraddTime (const string &name, int flags=0, int style=0)
 
ParameterinsertTime (const string &name, const string &atname="", const string &request="", int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
 
ParameterinsertTime (const string &name, const string &atname, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
 
ParameterinsertTime (const string &name, const string &atname, int flags=0, int style=0)
 
const Parametertime (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
 
ParametersetTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
 
ParametersetTime (const string &name, const string &time)
 
ParametersetTime (const string &name, const struct tm &time)
 
ParametersetTime (const string &name, const time_t &time)
 
ParametersetCurrentTime (const string &name)
 
ParametersetTime (const string &name, const Parameter &p)
 
const ParameterdefaultTime (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
 
ParametersetDefaultTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
 
OptionsnewSection (int level, const string &name, const string &type="", int flag=0, int style=0)
 
OptionsnewSection (int level, const string &name, int flag, int style=0)
 
OptionsnewSection (const string &name, const string &type="", int flag=0, int style=0)
 
OptionsnewSection (const string &name, int flag, int style=0)
 
OptionsnewSubSection (const string &name, const string &type="", int flag=0, int style=0)
 
OptionsnewSubSection (const string &name, int flag, int style=0)
 
OptionsnewSubSubSection (const string &name, const string &type="", int flag=0, int style=0)
 
OptionsnewSubSubSection (const string &name, int flag, int style=0)
 
OptionsaddSection (const string &name, const string &type="", int flag=0, int style=0)
 
OptionsaddSection (const string &name, int flag, int style=0)
 
OptionsinsertSection (const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
OptionsinsertSection (const string &name, const string &atpattern, int flag, int style=0)
 
OptionsnewSection (int level, const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSection (int level, const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSection (int level, const Options &opt, const string &name, int flag, int style=0)
 
OptionsnewSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSection (const Options &opt, const string &name, int flag, int style=0)
 
OptionsnewSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSubSection (const Options &opt, const string &name, int flag, int style=0)
 
OptionsnewSubSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSubSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsnewSubSubSection (const Options &opt, const string &name, int flag, int style=0)
 
OptionsaddSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsaddSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
OptionsaddSection (const Options &opt, const string &name, int flag, int style=0)
 
OptionsinsertSection (const Options &opt, int selectmask, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
OptionsinsertSection (const Options &opt, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
OptionsinsertSection (const Options &opt, const string &name, const string &atpattern, int flag, int style=0)
 
OptionsnewSection (Options *opt, bool newparent=false)
 
OptionsaddSection (Options *opt, bool newparent=false)
 
OptionsinsertSection (Options *opt, const string &atpattern, bool newparent=false)
 
OptionsnewSections (Options *opt, bool newparent=false)
 
void endSection (void)
 
void clearSections (void)
 
void setSection (Options &opt)
 
void lastSection (void)
 
int up (void)
 
int down (void)
 
ParametersetDefault (const string &name)
 
OptionssetDefaults (int flags=0)
 
ParametersetToDefault (const string &name)
 
OptionssetToDefaults (int flags=0)
 
Optionserase (iterator p)
 
Optionserase (section_iterator p)
 
Optionserase (Options *s)
 
Optionserase (const string &pattern)
 
Optionserase (int selectflag)
 
Optionspop (void)
 
OptionspopSection (void)
 
Optionsflatten (Options *root=0)
 
Optionsclear (bool revert=true)
 
int size (void) const
 
int size (int selectflag) const
 
bool empty (void) const
 
int parameterSize (void) const
 
int parameterSize (int flags) const
 
int sectionsSize (void) const
 
int sectionsSize (int flags) const
 
bool exist (const string &pattern) const
 
bool existSection (const string &pattern) const
 
OptionssetFlags (int flags, int selectflag=0)
 
OptionsaddFlags (int flags, int selectflag=0)
 
OptionsdelFlags (int flags, int selectflag=0)
 
OptionssetValueTypeFlags (int flags, int typemask)
 
OptionsaddValueTypeFlags (int flags, int typemask)
 
OptionsdelValueTypeFlags (int flags, int typemask)
 
OptionssetStyles (int style, int selectflag=0)
 
OptionsaddStyles (int style, int selectflag=0)
 
OptionsdelStyles (int style, int selectflag=0)
 
int styleSize (int style) const
 
OptionssetValueTypeStyles (int style, int typemask)
 
OptionsaddValueTypeStyles (int style, int typemask)
 
OptionsdelValueTypeStyles (int style, int typemask)
 
int nameWidth (int selectmask=0, bool detailed=false, bool escape=false) const
 
string save (int selectmask=0, int flags=0) const
 
ostream & save (ostream &str, const string &start="", int selectmask=0, int flags=0, int width=-1) const
 
ostream & save (ostream &str, const string &textformat, const string &numberformat, const string &boolformat="%i=%b", const string &dateformat="%i=%04Y-%02m-%02d", const string &timeformat="%i=%02H:%02M:%02S", const string &sectionformat="%i", int selectmask=0, const string &start="") const
 
ostream & saveXML (ostream &str, int selectmask=0, int flags=0, int level=0, int indent=4) const
 
Optionsread (const string &opttxt, int flag, const string &assignment=":=", const string &separator=",;", int *indent=0)
 
Optionsread (const string &opttxt, const string &assignment=":=", const string &separator=",;")
 
istream & read (istream &str, int flag, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
 
istream & read (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
 
Optionsread (const StrQueue &sq, int flag=0, const string &assignment=":=")
 
bool read (const Parameter &p, int flag=0)
 
Optionsread (const Options &o, int flags=0, int flag=0)
 
bool readAppend (const Parameter &p)
 
OptionsreadAppend (const Options &o, int flags=0)
 
Optionsload (const Str &opttxt, const string &assignment=":=", const string &separator=",;", int *indent=0, int *indentspacing=0, int *level=0)
 
istream & load (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
 
Optionsload (const StrQueue &sq, const string &assignment=":=")
 
virtual void notify (void)
 
void callNotifies (void)
 
bool setNotify (bool notify=true)
 
bool unsetNotify (void)
 
bool notifying (void) const
 

Additional Inherited Members

- Public Slots inherited from RELACSPlugin
virtual void saveDoxygenOptions (void)
 
virtual void saveWidget (void)
 
- Public Slots inherited from ConfigDialog
virtual void dialog (void)
 
virtual void help (void)
 
virtual void notifyDialog (const Options &opt)
 
- Signals inherited from ConfigDialog
void dialogAccepted (void)
 
void dialogAction (int r)
 
void dialogClosed (int r)
 
- Static Public Member Functions inherited from ConfigClass
static void setConfigureClasses (ConfigureClasses *cfg)
 
- Static Public Member Functions inherited from Options
static double floorLog10 (double v)
 
static double floor10 (double v, double scale=1.0)
 
static double ceil10 (double v, double scale=1.0)
 
- Static Public Attributes inherited from RELACSPlugin
static const int DeviceId = 0x0001
 
static const int AnalogInputId = 0x0002
 
static const int AnalogOutputId = 0x0004
 
static const int DigitalIOId = 0x0008
 
static const int TriggerId = 0x0010
 
static const int AttenuatorId = 0x0020
 
static const int AttenuateId = 0x0040
 
static const int ModelId = 0x0080
 
static const int FilterId = 0x0100
 
static const int ReProId = 0x0200
 
static const int ControlId = 0x0400
 
static const int Core = 0
 
static const int Plugins = 1
 
- Static Public Attributes inherited from Options
static const int NonDefault = Parameter::NonDefault
 
static const long TabSection = 0x04000000
 
- Protected Slots inherited from RELACSPlugin
void startTheSession (void)
 
void stopTheSession (void)
 
void toggleSession (void)
 
void removeFocus (void)
 
void muteAudioMonitor (void)
 
void unmuteAudioMonitor (void)
 
virtual void customEvent (QEvent *qce)
 
void widgetDestroyed (QObject *obj)
 
- Protected Slots inherited from ConfigDialog
void notificationFromDialog (const Parameter &p)
 
virtual void dClosed (int r)
 
virtual void hClosed (int r)
 
- Protected Member Functions inherited from RELACSPlugin
virtual void setPluginSet (const string &pluginset)
 
void printlog (const string &s) const
 
void warning (const string &s, double timeout=0.0)
 
void info (const string &s, double timeout=0.0)
 
void postCustomEvent (int type=0)
 
int maxVoltages (const InData &data, vector< double > &ranges) const
 
int maxValues (const InData &data, vector< double > &ranges) const
 
void setGain (const InData &data, int gainindex)
 
void adjustGain (const InData &data, double maxvalue)
 
void adjustGain (const InData &data, double minvalue, double maxvalue)
 
void adjust (const InData &data, double tbegin, double tend, double threshold)
 
void adjust (const InData &data, double duration, double threshold)
 
int activateGains (void)
 
Controlcontrol (int index)
 
Controlcontrol (const string &name)
 
OptionscontrolOpts (int index)
 
OptionscontrolOpts (const string &name)
 
void lockControl (int index)
 
void lockControl (const string &name)
 
void unlockControl (int index)
 
void unlockControl (const string &name)
 
Modelmodel (void)
 
OptionsmodelOpts (void)
 
void lockModel (void)
 
void unlockModel (void)
 
ReProsrepros (void)
 
OptionsreprosDialogOpts (void)
 
ReProrepro (int index)
 
ReProrepro (const string &name)
 
OptionsreproOpts (int index)
 
OptionsreproOpts (const string &name)
 
void lockRePro (int index)
 
void lockRePro (const string &name)
 
void unlockRePro (int index)
 
void unlockRePro (const string &name)
 
ReProcurrentRePro (void)
 
OptionscurrentReProOpts (void)
 
void lockCurrentRePro (void)
 
void unlockCurrentRePro (void)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual bool eventFilter (QObject *obj, QEvent *event)
 
void setWaitMouseCursor (void)
 
void restoreMouseCursor (void)
 
- Protected Member Functions inherited from ConfigDialog
void setDialogOpen (bool open=true)
 
void setHelpOpen (bool open=true)
 
- Protected Attributes inherited from RELACSPlugin
RELACSWidgetRW
 
- Protected Attributes inherited from ConfigDialog
Options DialogOptions
 

Detailed Description

Basic virtual class for filtering or detecting events (e.g. spikes)

Author
Jan Benda

Member Enumeration Documentation

enum FilterType

The different types of filters and event detectors.

Enumerator
SingleAnalogFilter 

Filters a single analog input trace.

MultipleAnalogFilter 

Filters multiple input traces.

SingleEventFilter 

Filters a single event trace.

MultipleEventFilter 

Filters multiple event traces.

SingleAnalogDetector 

Detects events in a single analog input trace.

MultipleAnalogDetector 

Detects multiple events in multiple input traces.

SingleEventDetector 

Detects events in a single event trace.

MultipleEventDetector 

Detects multiple events in multiple event traces.

MultipleTraces 

This bit indicates multiple input and output traces.

EventInput 

This bit indicates events as input to the filter or detector.

EventDetector 

This bit indicates an event detector.

Constructor & Destructor Documentation

Filter ( const string &  ident,
int  mode,
FilterType  type,
int  outtraces = 0,
const string &  name = "",
const string &  pluginset = "",
const string &  author = "unknown",
const string &  version = "unknown",
const string &  date = __DATE__ 
)

The constructor. When implementing a Filter, the constructor must have the following signature

class MyFilter : public Filter
{
public
MyFilter::MyFilter( const string &ident, int mode );
};

ident and mode are determined from the config file and should simply be passed to this constructor.

Parameters
[in]identa unique identifier for each instance of the Filter plugin.
[in]modeis passed to the resulting InData or EventData.
[in]typedetermines the type of the filter or detector.
[in]outtracesis the number of produced output traces. If outtraces == 0, then the number of output traces equals the number of input traces.
[in]namethe name of the Filter plugin (has to be identical to the class name)
[in]pluginsetthe name of the plugin-set the Filter plugin belongs to
[in]authorname(s) of the person(s) who progammed the plugin
[in]versiona version string
[in]datedate of the last change

References Filter::ident(), Filter::mode(), Filter::MultipleAnalogDetector, Filter::MultipleEventDetector, ConfigDialog::name(), ConfigClass::setConfigIdent(), Filter::setName(), Filter::SingleAnalogDetector, Filter::SingleEventDetector, and Filter::type().

~Filter ( void  )
virtual

The destructor.

Member Function Documentation

virtual int init ( const InData indata,
InData outdata 
)
inlinevirtual

Reimplement this function to initialize your filter. This function is for initializing filters that filter a single trace of the analog data given in indata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outdata with an appropriate unit using InData::setUnit(). Default unit is the unit of indata. Returns zero on success or one at failure.

Referenced by FilterDetectors::createFilters().

virtual int init ( const InList indata,
InList outdata 
)
inlinevirtual

Reimplement this function to initialize your filter. This function is for initializing filters that filter multiple traces of the analog data given in indata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outdata with an appropriate unit using InData::setUnit(). Default unit is the unit of the first trace in indata. Returns zero on success or one at failure.

virtual int init ( const EventData inevents,
InData outdata 
)
inlinevirtual

Reimplement this function to initialize your filter. This function is for initializing filters that filter the events inevents. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outdata with an appropriate unit using InData::setUnit(). Default unit is EventData::sizeUnit() of inevents. Returns zero on success or one at failure.

virtual int init ( const EventList inevents,
InList outdata 
)
inlinevirtual

Reimplement this function to initialize your filter. This function is for initializing filters that filter multiple events inevents. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outdata with an appropriate unit using InData::setUnit(). Default unit is EventData::sizeUnit() of the first EventData in inevents. Returns zero on success or one at failure.

virtual int init ( const InData indata,
EventData outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function to initialize your event detector. This function is for initializing detectors that detect events in a single trace of the analog data given in indata. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outevents with appropriate names, scale factors, units and formats if required (EventData::setSizeName(), EventData::setSizeScale(), EventData::setSizeUnit(), EventData::setSizeFormat(), EventData::setWidthName(), EventData::setWidthScale(), EventData::setWidthUnit(), EventData::setWidthFormat()) Returns zero on success or one at failure.

virtual int init ( const InList indata,
EventList outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function to initialize your event detector. This function is for initializing detectors that detect events in multiple traces of the analog data given in indata. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outevents with appropriate names, scale factors, units and formats if required (EventData::setSizeName(), EventData::setSizeScale(), EventData::setSizeUnit(), EventData::setSizeFormat(), EventData::setWidthName(), EventData::setWidthScale(), EventData::setWidthUnit(), EventData::setWidthFormat()) Returns zero on success or one at failure.

virtual int init ( const EventData inevents,
EventData outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function to initialize your event detector. This function is for initializing detectors that detect events in the events inevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outevents with appropriate names, scale factors, units and formats if required (EventData::setSizeName(), EventData::setSizeScale(), EventData::setSizeUnit(), EventData::setSizeFormat(), EventData::setWidthName(), EventData::setWidthScale(), EventData::setWidthUnit(), EventData::setWidthFormat()) Returns zero on success or one at failure.

virtual int init ( const EventList inevents,
EventList outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function to initialize your event detector. This function is for initializing detectors that detect events in the multiple events inevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. Initialize the outevents with appropriate names, scale factors, units and formats if required (EventData::setSizeName(), EventData::setSizeScale(), EventData::setSizeUnit(), EventData::setSizeFormat(), EventData::setWidthName(), EventData::setWidthScale(), EventData::setWidthUnit(), EventData::setWidthFormat()) Returns zero on success or one at failure.

virtual int adjust ( const InData indata,
InData outdata 
)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters that filter a single trace of the analog data given in indata and write their result to outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

Referenced by FilterDetectors::createFilters().

virtual int adjust ( const InList indata,
InList outdata 
)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters that filter multiple traces of the analog data given in indata and write their result to outdata.. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const EventData inevents,
InData outdata 
)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters that filter the events in inevents and write their result to outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const EventList inevents,
InList outdata 
)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters that filter multiple events in inevents and write their result to outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const InData indata)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters and detectors that detect events in a single trace of the analog data given in indata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const InList indata)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters and detectors that detect events in multiple traces of the analog data given in indata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const EventData inevents)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters and detectors that detect events in the events inevents. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int adjust ( const EventList inevents)
inlinevirtual

Reimplement this function to react to changes in the input gain. This function is for filters and detectors that detect events in the multiple events inevents. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. Your reimplementation should return 0.

virtual int autoConfigure ( const InData indata,
double  tbegin,
double  tend 
)
inlinevirtual

Reimplement this function to react to automatically set parameters of the filter/detector, based on the input data between the times tbegin and tend. This function is for filters and detectors that detect events in a single trace of the analog data given in indata. The filter and the data are already locked during this function by lock() and readLockData(), respectively. Your reimplementation should return 0 on success.

Referenced by FilterData::autoConfigure(), and FilterDetectors::createFilters().

virtual int autoConfigure ( const InList indata,
double  tbegin,
double  tend 
)
inlinevirtual

Reimplement this function to react to automatically set parameters of the filter/detector, based on the input data between the times tbegin and tend. This function is for filters and detectors that detect events in multiple traces of the analog data given in indata. The filter and the data are already locked during this function by lock() and readLockData(), respectively. Your reimplementation should return 0 on success.

virtual int autoConfigure ( const EventData inevents,
double  tbegin,
double  tend 
)
inlinevirtual

Reimplement this function to react to automatically set parameters of the filter/detector, based on the input data between the times tbegin and tend. This function is for filters and detectors that detect events in the events inevents. The filter and the data are already locked during this function by lock() and readLockData(), respectively. Your reimplementation should return 0 on success.

virtual int autoConfigure ( const EventList inevents,
double  tbegin,
double  tend 
)
inlinevirtual

Reimplement this function to react to automatically set parameters of the filter/detector, based on the input data between the times tbegin and tend. This function is for filters and detectors that detect events in the multiple events inevents. The filter and the data are already locked during this function by lock() and readLockData(), respectively. Your reimplementation should return 0 on success.

virtual int filter ( const InData indata,
InData outdata 
)
inlinevirtual

Reimplement this function with an appropriate filter. This function filters a single trace of the analog data given in indata. The filtered trace is stored in outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

Referenced by FilterDetectors::createFilters().

virtual int filter ( const InList indata,
InList outdata 
)
inlinevirtual

Reimplement this function with an appropriate filter. This function filters multiple traces of the analog data given in indata. The filtered traces are stored in outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual int filter ( const EventData inevents,
InData outdata 
)
inlinevirtual

Reimplement this function with an appropriate filter. This function filters the events inevents. The filtered trace is stored in outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual int filter ( const EventList inevents,
InList outdata 
)
inlinevirtual

Reimplement this function with an appropriate filter. This function filters multiple events inevents. The filtered traces are stored in outdata. The filter and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual int detect ( const InData data,
EventData outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function with an appropriate event detector. This function detects events in a single trace of the analog data given in data. The trace number is specified by events->trace(). The events are stored in outevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

Referenced by FilterDetectors::createFilters().

virtual int detect ( const InList data,
EventList outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function with an appropriate event detector. This function detects events in multiple traces of the analog data given in data. The trace numbers are specified by events->trace() and event->traceNum(). The events are stored in outevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual int detect ( const EventData inevents,
EventData outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function with an appropriate event detector. This function detects events in the events inevents. The detected events are stored in outevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual int detect ( const EventList inevents,
EventList outevents,
const EventList other,
const EventData stimuli 
)
inlinevirtual

Reimplement this function with an appropriate event detector. This function detects events in multiple events inevents. The events are stored in outevents. The detector and the data are already locked during this function by lock() and writeLockData(), respectively. This function is called periodically whenever a new chunk of data is available. Your reimplementation should return 0.

virtual void save ( const string &  param)
inlinevirtual

Reimplement this function if you want to save some data of your filter/detector. This function might be called by a RePro or Session or from a Macro with some arbitrary string param.

Note
The filter is NOT locked during the call of save()!

Referenced by MacroCommand::execute().

void save ( void  )
inline

Calls the save() function with an empty param string.

References Filter::save().

Referenced by Filter::save().

const string & ident ( void  ) const
void setIdent ( const string &  ident)
virtual
void setName ( const string &  name)
virtual
FilterType type ( void  ) const
inline

Indicates which of the different types of filter or detector functions are supported by the event detector.

Referenced by FilterData::autoConfigure(), FilterDetectors::createFilters(), and Filter::Filter().

int outTraces ( void  ) const
inline

The number of output traces (of InData or EventData) the detector produces.

Referenced by FilterData::FilterData().

int mode ( void  ) const
inline

Mode which is passed to the corresponding output InData or EventData.

Referenced by Filter::Filter(), and Filter::setMode().

void setMode ( int  mode)
inline

Set the mode which is passed to the corresponding output InData or EventData to mode.

References Filter::mode().

Referenced by FilterDetectors::createFilters().


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