Relacs  0.9.8
Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
DigitalIO Class Referenceabstract

#include <digitalio.h>

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

Public Member Functions

 DigitalIO (const string &deviceclass)
 
virtual ~DigitalIO (void)
 
virtual int open (const string &device) override
 
virtual int open (Device &device) override
 
virtual bool isOpen (void) const =0
 
virtual void close (void)=0
 
virtual int lines (void) const =0
 
virtual const Options & settings (void) const
 
int allocateLines (unsigned int lines)
 
int allocateLine (unsigned int line)
 
int allocateLine (unsigned int line, int id)
 
void freeLines (int id)
 
bool allocatedLines (unsigned int lines, int id)
 
bool allocatedLines (unsigned int lines)
 
bool allocatedLine (unsigned int line, int id)
 
bool allocatedLine (unsigned int line)
 
virtual int configureLine (unsigned int line, bool output)
 
virtual int configureLines (unsigned int lines, unsigned int output)
 
bool lineConfiguration (unsigned int line) const
 
virtual int write (unsigned int line, bool val)=0
 
virtual int read (unsigned int line, bool &val)=0
 
virtual int writeLines (unsigned int lines, unsigned int val)=0
 
virtual int readLines (unsigned int lines, unsigned int &val)=0
 
virtual int setSyncPulse (int modemask, int modebits, unsigned int line, double duration, int mode=0)
 
virtual int clearSyncPulse (int modemask, int modebits)
 
- Public Member Functions inherited from Device
 Device (int type=MiscellaneousType)
 
 Device (const string &deviceclass, int type=MiscellaneousType)
 
virtual ~Device (void)
 
virtual int reset (void)
 
virtual const Options & info (void) const
 
int deviceType (void) const
 
string deviceTypeStr (void) const
 
string deviceClass (void) const
 
string deviceFile (void) const
 
string deviceName (void) const
 
string deviceVendor (void) const
 
string deviceIdent (void) const
 
virtual void setDeviceIdent (const string &ident)
 
virtual void clearError (void)
 
virtual string errorStr (void) const
 
void setErrorStr (const string &strg)
 
void addErrorStr (const string &strg)
 
void setErrorStr (int errnum)
 
void addErrorStr (int errnum)
 
virtual bool success (void) const
 
virtual bool failed (void) const
 
- 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)
 
Options & operator= (const Options &o)
 
Options & assign (const Options &o)
 
Options & append (const Options &o)
 
Options & add (const Options &o)
 
Options & insert (const Options &o, const string &atname="")
 
Options & assign (const Options &o, int flags)
 
Options & copy (Options &o, int flags)
 
Options & append (const Options &o, int flags)
 
Options & add (const Options &o, int flags)
 
Options & insert (const Options &o, int flags, const string &atname="")
 
Parameter * assign (const string &name, const string &value)
 
Options * parentSection (void)
 
const Options * parentSection (void) const
 
void setParentSection (Options *parentsection)
 
void resetParents (void)
 
Options * rootSection (void)
 
const Options * rootSection (void) const
 
string name (void) const
 
virtual void setName (const string &name)
 
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
 
Options & setFlag (int flag)
 
Options & addFlag (int flag)
 
Options & delFlag (int flag)
 
Options & clearFlag (void)
 
int style (void) const
 
Options & setStyle (int style)
 
Options & addStyle (int style)
 
Options & delStyle (int style)
 
Options & clearStyle (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 Parameter & operator[] (int i) const
 
Parameter & operator[] (int i)
 
const Parameter & operator[] (const string &name) const
 
Parameter & operator[] (const string &name)
 
const Options & section (int i) const
 
Options & section (int i)
 
const Options & section (const string &name) const
 
Options & section (const string &name)
 
Str request (const string &name) const
 
Parameter & setRequest (const string &name, const string &request)
 
Parameter::ValueType valueType (const string &name) const
 
Parameter & setValueType (const string &name, Parameter::ValueType type)
 
int flags (const string &name) const
 
bool flags (const string &name, int flag) const
 
Parameter & setFlags (const string &name, int flags)
 
Parameter & addFlags (const string &name, int flags)
 
Parameter & delFlags (const string &name, int flags)
 
Parameter & clearFlags (const string &name)
 
bool changed (const string &name)
 
int style (const string &name) const
 
Parameter & setStyle (const string &name, int style)
 
Parameter & addStyle (const string &name, int style)
 
Parameter & delStyle (const string &name, int style)
 
Str format (const string &name) const
 
Parameter & setFormat (const string &name, int width=0, int prec=-1, char fmt='g')
 
Parameter & setFormat (const string &name, const string &format)
 
int formatWidth (const string &name) const
 
int size (const string &name) const
 
Parameter & add (const Parameter &np)
 
Parameter & insert (const Parameter &np, const string &atname="")
 
Parameter & addText (const string &name, const string &request, const string &dflt, int flags=0, int style=0)
 
Parameter & addText (const string &name, const string &dflt="", int flags=0, int style=0)
 
Parameter & insertText (const string &name, const string &atname, const string &request, const string &dflt, int flags=0, int style=0)
 
Parameter & insertText (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
 
Parameter & setText (const string &name, const string &strg)
 
Parameter & setText (const string &name, const Parameter &p)
 
Parameter & pushText (const string &name, const string &strg)
 
Str defaultText (const string &name, const string &format="", const string &unit="") const
 
Parameter & setDefaultText (const string &name, const string &dflt)
 
Parameter & addSelection (const string &name, const string &request, const string &selection, int flags=0, int style=0)
 
Parameter & addSelection (const string &name, const string &selection="", int flags=0, int style=0)
 
Parameter & insertSelection (const string &name, const string &atname, const string &request, const string &selection, int flags=0, int style=0)
 
Parameter & insertSelection (const string &name, const string &atname="", const string &selection="", int flags=0, int style=0)
 
Parameter & selectText (const string &name, const string &strg, int add=0)
 
Parameter & selectText (const string &name, int index)
 
int index (const string &name) const
 
int index (const string &name, const string &strg) const
 
Parameter & addNumber (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)
 
Parameter & addNumber (const string &name, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & addNumber (const string &name, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & addNumber (const string &name, double dflt, const string &unit, int flags, int style=0)
 
Parameter & addNumber (const string &name, double dflt, double error, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & addNumber (const string &name, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & insertNumber (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)
 
Parameter & insertNumber (const string &name, const string &atname, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & insertNumber (const string &name, const string &atname, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
 
Parameter & insertNumber (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
 
Parameter & setNumber (const string &name, double number, double error, const string &unit="")
 
Parameter & setNumber (const string &name, double number, const string &unit="")
 
Parameter & pushNumber (const string &name, double number, double error=-1.0, const string &unit="")
 
Parameter & pushNumber (const string &name, double number, const string &unit)
 
Parameter & setNumber (const string &name, const Parameter &p)
 
double defaultNumber (const string &name, const string &unit="") const
 
Parameter & setDefaultNumber (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
 
Parameter & setStep (const string &name, double step, const string &unit="")
 
Parameter & setMinMax (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
 
Parameter & setUnit (const string &name, const string &internunit, const string &outunit="")
 
Parameter & setOutUnit (const string &name, const string &outputunit)
 
Parameter & changeUnit (const string &name, const string &internunit)
 
Parameter & addInteger (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)
 
Parameter & addInteger (const string &name, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
 
Parameter & addInteger (const string &name, const string &unit="")
 
Parameter & insertInteger (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)
 
Parameter & insertInteger (const string &name, const string &atname, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
 
Parameter & insertInteger (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
 
Parameter & setInteger (const string &name, long number, long error, const string &unit="")
 
Parameter & setInteger (const string &name, long number, const string &unit="")
 
Parameter & pushInteger (const string &name, long number, long error, const string &unit="")
 
Parameter & pushInteger (const string &name, long number, const string &unit="")
 
Parameter & setInteger (const string &name, const Parameter &p)
 
long defaultInteger (const string &name, const string &unit="") const
 
Parameter & setDefaultInteger (const string &name, long dflt, const string &unit="")
 
Parameter & setMinMax (const string &name, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="")
 
Parameter & setMinMax (const string &name, int minimum, int maximum, int step=1, const string &unit="")
 
Parameter & addBoolean (const string &name, const string &request, bool dflt, int flags=0, int style=0)
 
Parameter & addBoolean (const char *name, const char *request, bool dflt, int flags=0, int style=0)
 
Parameter & addBoolean (const string &name, bool dflt, int flags=0, int style=0)
 
Parameter & addBoolean (const char *name, bool dflt, int flags=0, int style=0)
 
Parameter & insertBoolean (const string &name, const string &atname="", const string &request="", bool dflt=false, int flags=0, int style=0)
 
Parameter & insertBoolean (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
 
Parameter & setBoolean (const string &name, bool b)
 
Parameter & setBoolean (const string &name, const Parameter &p)
 
bool defaultBoolean (const string &name) const
 
Parameter & setDefaultBoolean (const string &name, bool dflt)
 
Parameter & addDate (const string &name, const string &request, int year=0, int month=0, int day=0, int flags=0, int style=0)
 
Parameter & addDate (const string &name, int year, int month, int day, int flags=0, int style=0)
 
Parameter & addDate (const string &name, int flags=0, int style=0)
 
Parameter & insertDate (const string &name, const string &atname="", const string &request="", int year=0, int month=0, int day=0, int flags=0, int style=0)
 
Parameter & insertDate (const string &name, const string &atname, int year=0, int month=0, int day=0, int flags=0, int style=0)
 
Parameter & insertDate (const string &name, const string &atname, int flags=0, int style=0)
 
const Parameter & date (const string &name, int index, int &year, int &month, int &day) const
 
Parameter & setDate (const string &name, int year, int month, int day)
 
Parameter & setDate (const string &name, const string &date)
 
Parameter & setDate (const string &name, const struct tm &date)
 
Parameter & setDate (const string &name, const time_t &time)
 
Parameter & setCurrentDate (const string &name)
 
Parameter & setDate (const string &name, const Parameter &p)
 
const Parameter & defaultDate (const string &name, int index, int &year, int &month, int &day) const
 
Parameter & setDefaultDate (const string &name, int year, int month, int day)
 
Parameter & addTime (const string &name, const string &request, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
 
Parameter & addTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0, int flags=0, int style=0)
 
Parameter & addTime (const string &name, int flags=0, int style=0)
 
Parameter & insertTime (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)
 
Parameter & insertTime (const string &name, const string &atname, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
 
Parameter & insertTime (const string &name, const string &atname, int flags=0, int style=0)
 
const Parameter & time (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
 
Parameter & setTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
 
Parameter & setTime (const string &name, const string &time)
 
Parameter & setTime (const string &name, const struct tm &time)
 
Parameter & setTime (const string &name, const time_t &time)
 
Parameter & setCurrentTime (const string &name)
 
Parameter & setTime (const string &name, const Parameter &p)
 
const Parameter & defaultTime (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
 
Parameter & setDefaultTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
 
Options & newSection (int level, const string &name, const string &type="", int flag=0, int style=0)
 
Options & newSection (int level, const string &name, int flag, int style=0)
 
Options & newSection (const string &name, const string &type="", int flag=0, int style=0)
 
Options & newSection (const string &name, int flag, int style=0)
 
Options & newSubSection (const string &name, const string &type="", int flag=0, int style=0)
 
Options & newSubSection (const string &name, int flag, int style=0)
 
Options & newSubSubSection (const string &name, const string &type="", int flag=0, int style=0)
 
Options & newSubSubSection (const string &name, int flag, int style=0)
 
Options & addSection (const string &name, const string &type="", int flag=0, int style=0)
 
Options & addSection (const string &name, int flag, int style=0)
 
Options & insertSection (const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
Options & insertSection (const string &name, const string &atpattern, int flag, int style=0)
 
Options & newSection (int level, const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSection (int level, const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSection (int level, const Options &opt, const string &name, int flag, int style=0)
 
Options & newSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSection (const Options &opt, const string &name, int flag, int style=0)
 
Options & newSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSubSection (const Options &opt, const string &name, int flag, int style=0)
 
Options & newSubSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSubSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & newSubSubSection (const Options &opt, const string &name, int flag, int style=0)
 
Options & addSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & addSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
 
Options & addSection (const Options &opt, const string &name, int flag, int style=0)
 
Options & insertSection (const Options &opt, int selectmask, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
Options & insertSection (const Options &opt, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
 
Options & insertSection (const Options &opt, const string &name, const string &atpattern, int flag, int style=0)
 
Options & newSection (Options *opt, bool newparent=false)
 
Options & addSection (Options *opt, bool newparent=false)
 
Options & insertSection (Options *opt, const string &atpattern, bool newparent=false)
 
Options & newSections (Options *opt, bool newparent=false)
 
void endSection (void)
 
void clearSections (void)
 
void setSection (Options &opt)
 
void lastSection (void)
 
int up (void)
 
int down (void)
 
Parameter & setDefault (const string &name)
 
Options & setDefaults (int flags=0)
 
Parameter & setToDefault (const string &name)
 
Options & setToDefaults (int flags=0)
 
Options & erase (iterator p)
 
Options & erase (section_iterator p)
 
Options & erase (Options *s)
 
Options & erase (const string &pattern)
 
Options & erase (int selectflag)
 
Options & pop (void)
 
Options & popSection (void)
 
Options & flatten (Options *root=0)
 
Options & clear (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
 
Options & setFlags (int flags, int selectflag=0)
 
Options & addFlags (int flags, int selectflag=0)
 
Options & delFlags (int flags, int selectflag=0)
 
Options & setValueTypeFlags (int flags, int typemask)
 
Options & addValueTypeFlags (int flags, int typemask)
 
Options & delValueTypeFlags (int flags, int typemask)
 
Options & setStyles (int style, int selectflag=0)
 
Options & addStyles (int style, int selectflag=0)
 
Options & delStyles (int style, int selectflag=0)
 
int styleSize (int style) const
 
Options & setValueTypeStyles (int style, int typemask)
 
Options & addValueTypeStyles (int style, int typemask)
 
Options & delValueTypeStyles (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
 
Options & read (const string &opttxt, int flag, const string &assignment=":=", const string &separator=",;", int *indent=0)
 
Options & read (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)
 
Options & read (const StrQueue &sq, int flag=0, const string &assignment=":=")
 
bool read (const Parameter &p, int flag=0)
 
Options & read (const Options &o, int flags=0, int flag=0)
 
bool readAppend (const Parameter &p)
 
Options & readAppend (const Options &o, int flags=0)
 
Options & load (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)
 
Options & load (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

void freeLines (void)
 
void setInfo (void)
 
- Protected Member Functions inherited from Device
void setDeviceType (int type)
 
void setDeviceClass (const string &deviceclass)
 
void setDeviceFile (const string &devicefile)
 
void setDeviceName (const string &devicename)
 
void setDeviceVendor (const string &devicevendor)
 
void addInfo (void)
 
void lock (void) const
 
void unlock (void) const
 
QMutex * mutex (void) const
 
virtual void initOptions (void)
 

Static Protected Attributes

static const unsigned int MaxDIOLines = 32
 

Additional Inherited Members

- Public Types inherited from Device
enum  DeviceTypes {
  MiscellaneousType = 0, AnalogInputType = 1, AnalogOutputType = 2, DigitalIOType = 3,
  TriggerType = 4, AttenuatorType = 5, AttenuateType = 6, ManipulatorType = 7,
  TemperatureType = 8, CameraType = 9
}
 
- 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
 
- Static Public Member Functions inherited from Device
static int deviceTypes (void)
 
static string deviceTypeStr (int type)
 
static string getErrorStr (int ern)
 
- 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 Device
static const int NotOpen = -1
 
static const int InvalidDevice = -2
 
static const int ReadError = -3
 
static const int WriteError = -4
 
static const int InvalidParam = -5
 
- Static Public Attributes inherited from Options
static const int NonDefault = Parameter::NonDefault
 
static const long TabSection = 0x04000000
 
- Protected Attributes inherited from Device
Options Info
 
Options Settings
 

Detailed Description

Interface for accessing digital input and output lines of a data-aquisition board.

Author
Jan Benda
Version
1.0 A digital I/O device has lines() of input or output lines that can be high or low. There a two ways to access the digital I/O lines. Either individually by their line (channel) number, or in groups by a bit pattern, where ech bit represents a single line (channel).

After opening the device by open(), the digitial I/O lines that you are going to use should be allocated by allocateLines() or allocateLine().

Then the digital I/O lines should be configured for input or output using configureLines() or configureLine().

Bits can be read from or written to the digitial I/O lines by the read() and write() functions.

In case you want to use a digitial I/O device within RELACS, your DigitalIO implementation needs to provide a void default constructor (i.e. with no parameters) that does not open the device. Also, include the header file <relacs/relacsplugin.h> and make the AnalogInput device known to RELACS with the addDigitalIO( ClassNameOfYourDigitalIOImplementation, PluginSetName ) macro.

Constructor & Destructor Documentation

DigitalIO ( const string &  deviceclass)

Constructs an DigitalIO with device class deviceclass.

See Also
setDeviceClass()

References DigitalIO::freeLines(), and DigitalIO::MaxDIOLines.

~DigitalIO ( void  )
virtual

Close the daq driver. Reimplement this destructor.

Member Function Documentation

int open ( const string &  device)
overridevirtual

Open the digital I/O device specified by device.

Returns
zero on success, or InvalidDevice (or any other negative number indicating the error). You should call freeLines() somewhere at the beginning and setInfo() somewhere at the end of the reimplmentation of this function.
See Also
isOpen(), close()

Reimplemented from Device.

Reimplemented in DIOSim.

References Options::clear(), DigitalIO::freeLines(), Device::Info, Device::InvalidDevice, DigitalIO::MaxDIOLines, and Device::setDeviceFile().

int open ( Device &  device)
overridevirtual

Open the digital I/O device specified by device.

Returns
zero on success, or InvalidDevice (or any other negative number indicating the error). You should call freeLines() somewhere at the beginning and setInfo() somewhere at the end of the reimplementation of this function.
See Also
isOpen(), close()

Reimplemented from Device.

Reimplemented in DIOSim.

References Options::clear(), Device::deviceIdent(), DigitalIO::freeLines(), Device::Info, Device::InvalidDevice, DigitalIO::MaxDIOLines, and Device::setDeviceFile().

virtual bool isOpen ( void  ) const
pure virtual
Returns
true if the device is open.
See Also
open(), close()

Implements Device.

Implemented in DIOSim.

virtual void close ( void  )
pure virtual

Close the device.

See Also
open(), isOpen()

Implements Device.

Implemented in DIOSim.

virtual int lines ( void  ) const
pure virtual
Returns
the number of digital I/O lines the device supports

Implemented in DIOSim.

Referenced by DigitalIO::setInfo(), and DigitalIO::settings().

const Options & settings ( void  ) const
virtual

Returns the ids for each digital I/O line.

Reimplemented from Device.

Reimplemented in DIOSim.

References Options::addInteger(), Options::addText(), Options::clear(), DigitalIO::lines(), and Device::Settings.

int allocateLines ( unsigned int  lines)

Allocate the lines lines of the digital I/O device.

Parameters
[in]linesa bit mask of the digital lines to be allocated.
Returns
the id, a positive number, of the allocated lines
WriteError if some of the lines have been already allocated
See Also
freeLines(), allocatedLines()

References DigitalIO::MaxDIOLines.

int allocateLine ( unsigned int  line)

Allocate the single digital I/O line line of the digital I/O device. Further lines can be allocated by calling allocateLine( int, int ).

Parameters
[in]linethe digital line (not its bitmask!) to be allocated.
Returns
the id, a positive number, of the allocated line
WriteError if the line has been already allocated
See Also
freeLines(), allocatedLine()

References relacs::line(), DigitalIO::MaxDIOLines, and Device::WriteError.

int allocateLine ( unsigned int  line,
int  id 
)

Allocate one more digital I/O line line of the digital I/O device for id id. The id should be the returned value of a previous call to allocateLine( int ).

Parameters
[in]linethe digital line (not its bitmask!) to be allocated.
[in]idthe id under which this line should be allocated.
Returns
the id, a positive number, of the allocated line (same as id)
WriteError if the line has been already allocated
See Also
freeLines(), allocatedLine()

References relacs::line(), DigitalIO::MaxDIOLines, and Device::WriteError.

void freeLines ( int  id)

Free the previously allocated digital I/O lines with id id.

See Also
allocateLines()

References DigitalIO::MaxDIOLines.

bool allocatedLines ( unsigned int  lines,
int  id 
)
Returns
true if all the digitial I/O lines lines have been allocated under id id.
Parameters
[in]linesthe bit mask of the digital lines.
[in]idthe id under which this line was previously allocated.
See Also
allocateLines()

References DigitalIO::MaxDIOLines.

bool allocatedLines ( unsigned int  lines)
Returns
true if all the digitial I/O lines lines have been allocated, independent of the ids.
Parameters
[in]linesthe bit mask of the digital lines.
See Also
allocateLines()

References DigitalIO::MaxDIOLines.

bool allocatedLine ( unsigned int  line,
int  id 
)
Returns
true if digitial I/O line line was allocated under id id.
Parameters
[in]linethe digital line (not its bitmask!)
[in]idthe id under which this line was previously allocated.
See Also
allocateLine()

References DigitalIO::MaxDIOLines.

bool allocatedLine ( unsigned int  line)
Returns
true if digitial I/O line line is allocated, independent of the id.
Parameters
[in]linethe digital line (not its bitmask!)
See Also
allocateLine()

References DigitalIO::MaxDIOLines.

int configureLine ( unsigned int  line,
bool  output 
)
virtual

Configure digital I/O line line for input (output = false) or output (output = true). When reimplementing this function, call this function on success.

Parameters
[in]linethe digital line (not its bitmask!)
[in]outputtrue if this line should be configured for output.
Returns
0 on success, otherwise a negative number indicating the error.
See Also
configureLines(), lineConfiguration()

References relacs::line(), DigitalIO::MaxDIOLines, and Device::WriteError.

int configureLines ( unsigned int  lines,
unsigned int  output 
)
virtual

Configure digital I/O lines specified by lines for input (0) or output (1) according to output. When reimplementing this function, call this function on success.

Parameters
[in]linesa bit mask of the digital lines to be configured.
[in]outputa bitmask for tha digital I/O lines that should be configured for output.
Returns
0 on success, otherwise a negative number indicating the error.
See Also
configureLine(), lineConfiguration()

References DigitalIO::MaxDIOLines.

bool lineConfiguration ( unsigned int  line) const

Returns the configuation of an digital I/O line.

Parameters
[in]linethe digital line (channel)
Returns
true, if the line has been configured for output.
See Also
configureLine(), configureLines()

References relacs::line(), and DigitalIO::MaxDIOLines.

virtual int write ( unsigned int  line,
bool  val 
)
pure virtual

Write val to the digital I/O line line.

Parameters
[in]linethe digital line (not its bitmask!)
[in]valthe value that should be written to the digital output line (true: high, false: low).
Returns
0 on success, otherwise a negative number indicating the error
See Also
read()
virtual int read ( unsigned int  line,
bool &  val 
)
pure virtual

Read from digital I/O line line and return value in val.

Parameters
[in]linethe digital line (not its bitmask!)
[out]valthe value that was read from to the digital input line (true: high, false: low).
Returns
0 on success, otherwise a negative number indicating the error
See Also
write()
virtual int writeLines ( unsigned int  lines,
unsigned int  val 
)
pure virtual

Write val to the digital I/O lines defined in lines.

Parameters
[in]linesa bit mask selecting the digital lines to be written.
[in]vala bit mask indicating what should be written to the digital output lines (1: high, 0: low).
Returns
0 on success, otherwise a negative number indicating the error
See Also
read()
virtual int readLines ( unsigned int  lines,
unsigned int &  val 
)
pure virtual

Read digital I/O lines and return them in val.

Parameters
[in]linesa bit mask selecting the digital lines from which to read.
[out]vala bit field returning the values read from to the digital input lines (1: high, 0: low).
Returns
0 on success, otherwise a negative number indicating the error
See Also
write()
int setSyncPulse ( int  modemask,
int  modebits,
unsigned int  line,
double  duration,
int  mode = 0 
)
virtual

Enables generation of TTL Pulses on DIO line line and the scaling of the current for analog output according to the measured period divided by the curent injection time of duration microseconds. This is used for synchronizing a discontinous current-clamp amplifier with an dynamic-clamp loop.

Parameters
[in]modemaskthe dio lines that switch the mode of the amplifier
[in]modebitsthe dio lines to be set high to switch the mode of the amplifier into synchronized current clamp mode
[in]linethe dio line where to put out the synchronizing pulses
[in]durationthe duration of the current injection of the amplifier in seconds.
[in]modehow the measured period is determined: 0: the fixed requested sampling interval, 1: the current period, > 1: the average over the mode last periods.
Returns
0 on success, a Device error code on failure.
See Also
clearSyncPulse()

References Device::InvalidDevice.

int clearSyncPulse ( int  modemask,
int  modebits 
)
virtual

Disable TTL Pulse generation and current scaling. Switch amplifier into a different mode.

Parameters
[in]modemaskthe dio lines that switch the mode of the amplifier
[in]modebitsthe dio lines to be set high to switch into the desired non syncrhonizing mode into synchronized current clamp mode
Returns
0 on success, a Device error code on failure.
See Also
setSyncPulse()

References Device::InvalidDevice.

void freeLines ( void  )
protected

Free all allocated digital I/O lines.

See Also
freeLines()

References DigitalIO::MaxDIOLines.

Referenced by DigitalIO::DigitalIO(), and DigitalIO::open().

void setInfo ( void  )
protected

Set the device info(). Call this function from open().

See Also
info()

References Device::addInfo(), Options::addInteger(), Options::clear(), Device::Info, and DigitalIO::lines().

Member Data Documentation

const unsigned int MaxDIOLines = 32
staticprotected

The maximum number of digital I/O lines.

Referenced by DigitalIO::allocatedLine(), DigitalIO::allocatedLines(), DigitalIO::allocateLine(), DigitalIO::allocateLines(), DigitalIO::configureLine(), DigitalIO::configureLines(), DigitalIO::DigitalIO(), DigitalIO::freeLines(), DigitalIO::lineConfiguration(), and DigitalIO::open().

The documentation for this class was generated from the following files:
Generated on Tue May 9 2017 19:23:37 for Relacs by   doxygen 1.8.6