Standard interface for character devices. e.g. GPIB, serial port, TCP/IP... More...
#include <charinterface.h>
Inheritance diagram for XCharInterface:
Public Types | |
| enum | { PARITY_NONE = 0, PARITY_ODD = 1, PARITY_EVEN = 2 } |
Public Member Functions | |
| XCharInterface (const char *name, bool runtime, const shared_ptr< XDriver > &driver) | |
| void | setGPIBUseSerialPollOnWrite (bool x) |
| void | setGPIBUseSerialPollOnRead (bool x) |
| void | setGPIBWaitBeforeWrite (int msec) |
| void | setGPIBWaitBeforeRead (int msec) |
| void | setGPIBWaitBeforeSPoll (int msec) |
| void | setGPIBMAVbit (unsigned char x) |
| bool | gpibUseSerialPollOnWrite () const |
| bool | gpibUseSerialPollOnRead () const |
| int | gpibWaitBeforeWrite () const |
| int | gpibWaitBeforeRead () const |
| int | gpibWaitBeforeSPoll () const |
| unsigned char | gpibMAVbit () const |
| void | setSerialBaudRate (unsigned int rate) |
| These properties should be set before open(). | |
| void | setSerialStopBits (unsigned int bits) |
| void | setSerialParity (unsigned int parity) |
| void | setSerial7Bits (bool enable) |
| void | setSerialFlushBeforeWrite (bool x) |
| void | setSerialEOS (const char *str) |
| be overridden by setEOS(). | |
| void | setSerialHasEchoBack (bool x) |
| unsigned int | serialBaudRate () const |
| unsigned int | serialStopBits () const |
| unsigned int | serialParity () const |
| bool | serial7Bits () const |
| bool | serialFlushBeforeWrite () const |
| const XString & | serialEOS () const |
| bool | serialHasEchoBack () const |
| virtual void | send (const XString &str) throw (XCommError &) |
| virtual void | send (const char *str) throw (XCommError &) |
| virtual void | write (const char *sendbuf, int size) throw (XCommError &) |
| virtual void | receive () throw (XCommError &) |
| virtual void | receive (unsigned int length) throw (XCommError &) |
| virtual bool | isOpened () const |
 Public Member Functions inherited from XCustomCharInterface | |
| XCustomCharInterface (const char *name, bool runtime, const shared_ptr< XDriver > &driver) | |
| const std::vector< char > & | buffer () const |
| int | scanf (const char *format,...) const __attribute__((format(scanf |
| error-check is user's responsibility. | |
| int double | toDouble () const throw (XConvError &) |
| int | toInt () const throw (XConvError &) |
| unsigned int | toUInt () const throw (XConvError &) |
| XString | toStr () const |
| XString | toStrSimplified () const |
| returns string white-spaces stripped. | |
| void | sendf (const char *format,...) __attribute__((format(printf throw (XInterfaceError &) |
| void void | queryf (const char *format,...) __attribute__((format(printf throw (XInterfaceError &) |
| void void void | setEOS (const char *str) |
| const XString & | eos () const |
| void | query (const XString &str) throw (XCommError &) |
| virtual void | query (const char *str) throw (XCommError &) |
| Public Member Functions inherited from XInterface | |
| XInterface (const char *name, bool runtime, const shared_ptr< XDriver > &driver) | |
| void | setLabel (const XString &str) |
| virtual XString | getLabel () const |
| shared_ptr< XDriver > | driver () const |
| const shared_ptr< XComboNode > & | device () const |
| type of interface or driver. | |
| const shared_ptr< XStringNode > & | port () const |
| port number or device name. | |
| const shared_ptr< XUIntNode > & | address () const |
| e.g. GPIB address. | |
| const shared_ptr< XBoolNode > & | control () const |
| True if interface is opened. Start/stop interface. | |
| void | lock () |
| void | unlock () |
| bool | isLocked () const |
| XRecursiveMutex & | mutex () |
| void | start () |
| void | stop () |
| Public Member Functions inherited from XNode | |
| XNode (const char *name, bool runtime=false) | |
| template<class T > | |
| shared_ptr< T > | create (const char *name) |
| template<class T , typename... Args> | |
| shared_ptr< T > | create (const char *name, bool runtime, Args &&...args) |
| template<class T > | |
| shared_ptr< T > | create (Transaction &tr, const char *name) |
| template<class T , typename... Args> | |
| shared_ptr< T > | create (Transaction &tr, const char *name, bool runtime, Args &&...args) |
| XString | getName () const |
| XString | getTypename () const |
| shared_ptr< XNode > | getChild (const XString &var) const |
| shared_ptr< XNode > | getParent () const |
| void | setUIEnabled (bool v) |
| Enables/disables controls over scripting/GUI. | |
| void | disable () |
| Disables all scripting/GUI operations on this node hereafter. | |
| Public Member Functions inherited from Transactional::Node< XNode > | |
| bool | insert (Transaction< XNode > &tr, const shared_ptr< XNode > &var, bool online_after_insertion=false) |
| void | insert (const shared_ptr< XNode > &var) |
| bool | release (Transaction< XNode > &tr, const shared_ptr< XNode > &var) |
| void | release (const shared_ptr< XNode > &var) |
| void | releaseAll () |
| bool | swap (Transaction< XNode > &tr, const shared_ptr< XNode > &x, const shared_ptr< XNode > &y) |
| void | swap (const shared_ptr< XNode > &x, const shared_ptr< XNode > &y) |
| XNode * | upperNode (Snapshot< XNode > &shot) |
| Finds the parent node in shot. | |
| Snapshot< XNode > | iterate_commit (Closure) |
| Snapshot< XNode > | iterate_commit_if (Closure) |
| void | iterate_commit_while (Closure) |
| void | print_ () const |
| Node (const Node &)=delete | |
| Node & | operator= (const Node &)=delete |
Protected Member Functions | |
| virtual void | open () throw (XInterfaceError &) |
| virtual void | close () throw (XInterfaceError &) |
| This can be called even if has already closed. | |
| shared_ptr< XPort > | openedPort () const |
Private Member Functions | |
| void | onSendRequested (const Snapshot &shot, XValueNodeBase *) |
| void | onQueryRequested (const Snapshot &shot, XValueNodeBase *) |
Private Attributes | |
| XString | m_serialEOS |
| bool | m_bGPIBUseSerialPollOnWrite |
| bool | m_bGPIBUseSerialPollOnRead |
| int | m_gpibWaitBeforeWrite |
| int | m_gpibWaitBeforeRead |
| int | m_gpibWaitBeforeSPoll |
| unsigned char | m_gpibMAVbit |
| unsigned int | m_serialBaudRate |
| don't check if zero | |
| unsigned int | m_serialStopBits |
| unsigned int | m_serialParity |
| bool | m_serial7Bits |
| bool | m_serialFlushBeforeWrite |
| bool | m_serialHasEchoBack |
| shared_ptr< XPort > | m_xport |
| shared_ptr< XStringNode > | m_script_send |
| for scripting | |
| shared_ptr< XStringNode > | m_script_query |
| shared_ptr< XListener > | m_lsnOnSendRequested |
| shared_ptr< XListener > | m_lsnOnQueryRequested |
Additional Inherited Members | |
| Static Public Member Functions inherited from XCustomCharInterface | |
| static std::vector< char > & | buffer_receive () |
| only for XPort and internal use. | |
Detailed Description
Standard interface for character devices. e.g. GPIB, serial port, TCP/IP...
Definition at line 81 of file charinterface.h.
The documentation for this class was generated from the following files:
- modules/charinterface/charinterface.h
- modules/charinterface/charinterface.cpp
