Relacs  0.9.8
Public Member Functions | Protected Member Functions | Friends | List of all members
Control Class Reference

#include <control.h>

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

Public Member Functions

 Control (const string &name, const string &pluginset="", const string &author="unknown", const string &version="unknown", const string &date=__DATE__)
 
virtual ~Control (void)
 
virtual void setName (const string &name)
 
virtual void initDevices (void)
 
void start (void)
 
virtual void requestStop (void)
 
bool wait (double time=-1.0)
 
virtual void addActions (QMenu *menu, bool doxydoc)
 
- 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
 

Protected Member Functions

virtual void main (void)
 
bool interrupt (void) const
 
bool waitOnData (double time=MAXDOUBLE)
 
bool waitOnReProSleep (double time=MAXDOUBLE)
 
bool waitOnReProFinished (double time=MAXDOUBLE)
 
bool waitOnSessionStart (double time=MAXDOUBLE)
 
bool waitOnSessionPrestop (double time=MAXDOUBLE)
 
bool waitOnSessionStop (double time=MAXDOUBLE)
 
bool sleep (double t)
 
void timeStamp (void)
 
bool sleepOn (double t)
 
- 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)
 

Friends

class ControlThread
 

Additional Inherited Members

- 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 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 Attributes inherited from RELACSPlugin
RELACSWidgetRW
 
- Protected Attributes inherited from ConfigDialog
Options DialogOptions
 

Detailed Description

Base class for widgets that control hardware or analyze data.

Author
Jan Benda

A Control widget can be used to control some hardware or analyze data independently and in parallel to the RePros. Use it to implement things that do not fit in the RePro, Session, or EventDetector concepts.

A Control widget has a name(), the last version() was written by author() on date(). This information is set either by the constructor or by setName(), setAuthor(), setVersion(), and setDate().

The Control is initialized by reimplementing preConfig(), config(), and initDevices().

For continuosly doing something use the Control thread by reimplementing main(). For synchronization with data, repros or sessions use waitOnData(), waitOnReProSleep(), waitOnReProFinished(), waitOnSessionStart(), waitOnSessionPrestop(), waitOnSessionStop(). Simply sleeping is possible with sleep(), timeStamp(), and sleepOn(). Within main() access to the Control is locked (via lock()), during the waitOn*(), sleep(), and sleepOn() functions access is unlocked (via unlock() ). You need to return from the thread if interrupt() returns true. If you want the thread to be stopped in a different way, reimplement requestStop(). Use lockGUI() and unlockGUI() to encapsulate code that directly or indirectly draws something on the screen.

A separate window displaying a warning message can be opened with warning(), a window displaying some information with info().

You are able to set the input gain for the data acquisition with setGain(), adjustGain(), adjust(), and activateGains(). Beware that a RePro may also set the gains.

addPath() prepends the current directory for data storage to a filename.

Access to other RELACS plugins is provided by devices(), device(), manipulator(), attenuator(), detector(), detectorOpts(), session(), sessionOpts(), sessionData(), sessionInfo(), sessionTime(), sessionTimeStr(), sessionRunning(), control(), controlOpts(), repro(), reproOpts(), currentRePro(), currentReProOpts().

You can define some Options (inherited via Config) that are stored in the relacsplugins.cfg file and that can be edited with the Control dialog(). You can select a subset of the Options for the dialog by defining a dialogSelectMask() with setDialogSelectMask() and addDialogSelectMask(). Likewise, some Options can be marked as read-only with dialogReadOnlyMask(), setDialogReadOnlyMask(), and addDialogReadOnlyMask(). The appearance of the dialog can be controlled with dialogStyle(), setDialogStyle(), and addDialogStyle(). dialogOpen() returns true if the dialog is already displayed.

Constructor & Destructor Documentation

Control ( const string &  name,
const string &  pluginset = "",
const string &  author = "unknown",
const string &  version = "unknown",
const string &  date = __DATE__ 
)

Construct a control widget with name name (has to be identical to the class name) that belongs to the set of plugins named pluginset. The implementation of a class derived from Control has the version version and was written by author on date.

References Control::ControlThread.

~Control ( void  )
virtual

Deconstruct the Control.

Member Function Documentation

void setName ( const string &  name)
virtual

Set the name of this Control to name and its identifier for the configuration file to "Control: \a name".

Reimplemented from RELACSPlugin.

References ConfigClass::setConfigIdent(), and RELACSPlugin::setName().

void initDevices ( void  )
virtual

This function is called AFTER the configuration parameters are read in and all the devices are initialized.. Implement this function to check for devices.

void start ( void  )

Start execution of the Control thread. Reimplement main() to make the thread do something.

void requestStop ( void  )
virtual

Kindly ask the Control thread to stop by setting interrupt() to true and interrupt a possible sleep().

bool wait ( double  time = -1.0)

Wait for the thread to finish execution (time < 0, returns true) or for time seconds to be elapsed (returns false).

References relacs::floor().

void addActions ( QMenu *  menu,
bool  doxydoc 
)
virtual

Add specific actions to the RELACS File-menu. This implementation adds a "Dialog" and a "Help" menu entry.

References ConfigDialog::dialog(), ConfigDialog::help(), RELACSPlugin::saveDoxygenOptions(), RELACSPlugin::saveWidget(), and RELACSPlugin::uniqueName().

void main ( void  )
protectedvirtual

Reimplement this function if you want to analyze input data traces and events. This function is executed as a thread. Within this thread the Control is locked (via lock() ). Access to those data is unlocked during sleep(), sleepOn(), and the waitOn* functions. To synchronize with the data, repros, or session use waitOnData(), waitOnReProSleep(), waitOnReProFinished(), waitOnSessionStart(), waitOnSessionPrestop(), waitOnSessionStop(). You need to return from main() if the waitOn*(), sleep(), or interrupt() functions return true.

See Also
interrupt(), sleep(), timeStamp(), sleepOn()
bool interrupt ( void  ) const
protected

Returns true if the thread should be stopped. Use this from within main()

void main( void )
{
...
if ( interrupt() )
return;
...
}

Referenced by Control::sleep(), Control::waitOnData(), Control::waitOnReProFinished(), Control::waitOnReProSleep(), Control::waitOnSessionPrestop(), Control::waitOnSessionStart(), and Control::waitOnSessionStop().

bool waitOnData ( double  time = MAXDOUBLE)
protected

Wait until new data are available or time seconds have been elapsed. Returns true if the thread needs to be stopped.

void main( void )
{
...
while ( ! waitOnData() ) {
analyzeData( data, events );
}
...
}
See Also
main(), interrupt(), waitOnReProSleep(), waitOnReProFinished(), waitOnSessionStart(), waitOnSessionPrestop(), waitOnSessionStop(), sleep(), timeStamp(), sleepOn()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool waitOnReProSleep ( double  time = MAXDOUBLE)
protected

Wait until the current RePro goes to sleep or time seconds have been elapsed. Returns true if the thread needs to be stopped.

See Also
main(), interrupt(), waitOnData(), waitOnReProFinished(), waitOnSessionStart(), waitOnSessionPrestop(), waitOnSessionStop(), sleep(), timeStamp(), sleepOn(), currentRePro(), currentReProOpts()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool waitOnReProFinished ( double  time = MAXDOUBLE)
protected

Wait until the current RePro has finished or time seconds have been elapsed. Returns true if the thread needs to be stopped.

See Also
main(), interrupt(), waitOnData(), waitOnReProSleep(), waitOnSessionStart(), waitOnSessionPrestop(), waitOnSessionStop(), sleep(), timeStamp(), sleepOn(), currentRePro(), currentReProOpts()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool waitOnSessionStart ( double  time = MAXDOUBLE)
protected

Wait until a new session starts or time seconds have been elapsed. Returns true if the thread needs to be stopped.

See Also
main(), interrupt(), waitOnData(), waitOnReProSleep(), waitOnSessionPrestop(), waitOnSessionStop(), sleep(), timeStamp(), sleepOn()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool waitOnSessionPrestop ( double  time = MAXDOUBLE)
protected

Wait until a session might be stopped or time seconds have been elapsed. Returns true if the thread needs to be stopped.

See Also
main(), interrupt(), waitOnData(), waitOnReProSleep(), waitOnSessionStart(), waitOnSessionStop(), sleep(), timeStamp(), sleepOn()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool waitOnSessionStop ( double  time = MAXDOUBLE)
protected

Wait until a session is stopped or time seconds have been elapsed. Returns true if the thread needs to be stopped.

See Also
main(), interrupt(), waitOnData(), waitOnReProSleep(), waitOnSessionStart(), waitOnSessionPrestop(), sleep(), timeStamp(), sleepOn()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::mutex(), and RELACSPlugin::RW.

bool sleep ( double  t)
protected

Sleep for t seconds. Returns true if the thread needs to be stopped.

See Also
main(), sleepOn(), timeStamp()

References RELACSPlugin::getData(), Control::interrupt(), ConfigDialog::lock(), ConfigDialog::mutex(), ConfigDialog::unlock(), and ControlThread::usleep().

Referenced by Control::sleepOn().

void timeStamp ( void  )
protected

Memorize the current time. This time is used by sleepOn() to calculate the remaining time to sleep.

See Also
main(), sleepOn(), sleep()
bool sleepOn ( double  t)
protected

Sleep for t seconds relative to the last call of timeStamp(). Returns true if the thread needs to be stopped.

timeStamp(); // memorize current time
doSomething(); // this takes a while
sleepOn( 0.5 ); // sleep for the remaining time to 500ms.
See Also
main(), sleep(), timeStamp()

References Control::sleep().

Friends And Related Function Documentation

friend class ControlThread
friend

Referenced by Control::Control().


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