Dokumentace třídy SerialPort_t
Třída pro komunikaci sériovou linkou. ...
#include <serialPort.h>
Diagram tříd pro SerialPort_t:
Třídy | |
| struct | Break |
| struct | serialPortOptions_s |
Veřejné typy | |
|
typedef struct SerialPort_t::serialPortOptions_s | serialPortOptions_t |
Veřejné metody | |
| void | open () |
| void | close () |
| bool | isOpen () |
| bool | getLastConnState () |
| void | setPort (const std::string &port) |
| const std::string & | getPort () const |
| template<typename SettableSerialPortOption > | |
| void | setOption (const SettableSerialPortOption &option) |
| template<typename GettableSerialPortOption > | |
| void | getOption (GettableSerialPortOption &option) |
| const serialPortOptions_s & | getOptions () const |
| void | write (const std::string &data) |
| std::string | read (const int &num) |
Statické veřejné metody | |
| static SerialPort_t * | Instance () |
Friends | |
| class | boost::serialization::access |
Detailní popis
Třída pro komunikaci sériovou linkou.
Jedná se o singleton. K jeho použití je možno využít přetížených operátorů.
Dokumentace k metodám
| void SerialPort_t::close | ( | ) |
Zavře port pro komunikaci.
| bool SerialPort_t::getLastConnState | ( | ) |
Vrátí příznak, jak byl port naposled ponechán.
- Návratová hodnota:
- true, pokud byl otevřen.
template<typename GettableSerialPortOption >
| void SerialPort_t::getOption | ( | GettableSerialPortOption & | option | ) | [inline] |
Vrátí parametr komunikace. Parametry vychází z boost::asio
- Parametry:
-
option Nový parametr.
| const SerialPort_t::serialPortOptions_s & SerialPort_t::getOptions | ( | ) | const |
Vrátí aktualní nastavení portu.
- Návratová hodnota:
- Nastavení.
| const std::string & SerialPort_t::getPort | ( | ) | const |
Vrátí nastavený port pro komunikaci.
- Parametry:
-
port jméno portu
| SerialPort_t * SerialPort_t::Instance | ( | ) | [static] |
Vrací ukazatel na instanci třídy. Pokud žádná instance neexistuje, tak je vytvořena.
| bool SerialPort_t::isOpen | ( | ) |
Vrátí příznak, zda je port otevřen.
- Návratová hodnota:
- true, pokud je otevřen.
| void SerialPort_t::open | ( | ) |
Otevře port pro komunikaci.
| string SerialPort_t::read | ( | const int & | num | ) |
Přečte žádaný počet znaků z linky. Blokující.
- Parametry:
-
num Požadovaný počet znaků.
- Návratová hodnota:
- Přečtený řetězec.
template<typename SettableSerialPortOption >
| void SerialPort_t::setOption | ( | const SettableSerialPortOption & | option | ) | [inline] |
Nastaví parametr komunikace. Parametry vychází z boost::asio
- Parametry:
-
option Nový parametr.
| void SerialPort_t::setPort | ( | const std::string & | port | ) |
Nastavý port pro komunikaci.
- Parametry:
-
port jméno portu
| void SerialPort_t::write | ( | const std::string & | data | ) |
Zapíše řetezec na linku.
- Parametry:
-
data Řetězec.
Dokumentace k friends
friend class boost::serialization::access [friend] |
Tato třida má přístup z důvodu serializace objektu.
Dokumentace pro tuto třídu byla generována z následujících souborů:
- libControl3Dp/serialPort.h
- libControl3Dp/serialPort.cpp
