Zum Hauptinhalt springen
Version: neueste

SerialStream

Haply::HardwareAPI::IO::SerialStream

Stellt einen std::iostream-kompatiblen Stream für eine serielle Schnittstelle bereit.

Soll in Verbindung mit den Klassen Inverse3 und den Handle-Klassen verwendet werden. Die API stellt die Klasse DeviceDetection zur Verfügung, um auf einfache Weise die seriellen Schnittstellen zu finden, die derzeit mit einem Haply Gerät verbunden sind.

OpenDevice oder die Übergabe von true an den Parameter von SerialStream ist erforderlich, bevor das Objekt mit einer der Geräteklassen verwendet werden kann.

Index​

Methoden​

NameTypBeschreibung
SerialStream(const char *, bool)Konstruiert ein SerialStream-Objekt aus ...
~SerialStream()Schließt die serielle Schnittstelle und gibt alle zugehörigen Ressourcen frei.
OpenDevicechar()Öffnet die serielle Schnittstelle und macht sie für eines der Geräte nutzbar ...
CloseDevicevoid()Mit dieser Funktion wird die serielle Schnittstelle geschlossen.
Verfügbarint()Diese Funktion gibt die Anzahl der zum Lesen verfügbaren Bytes zurück ...
WriteBytesvoid(const char *, size_t)Diese Funktion schreibt die angegebenen Daten an die serielle Schnittstelle.

Methoden​

SerialStream​

SerialStream( const char * port, bool open)

Konstruiert ein SerialStream-Objekt aus der angegebenen seriellen Schnittstelle.

WARNUNG Wenn open als übergeben wird und beim Öffnen des Ports ein Fehler auftritt, wird ein Fehler in stderr geschrieben und das resultierende Objekt ist ungültig.

Parameter​

  • port Die zu öffnende serielle Schnittstelle. Unter Windows muss seriellen Anschlüssen über 9 ein Präfix vorangestellt werden, um gültig zu sein. Als Beispiel sollte oder verwendet werden, um die serielle Schnittstelle zu öffnen.

  • open Wenn true, wird Opendevice im Konstruktor aufgerufen.

~SerialStream​

~SerialStream()

Schließt die serielle Schnittstelle und gibt alle zugehörigen Ressourcen frei.

OpenDevice​

char OpenDevice()

Öffnet die serielle Schnittstelle und macht sie für eine der Geräteklassen nutzbar.

Rückgabe​

Gibt den Wert Null zurück, wenn die Schnittstelle erfolgreich geöffnet wurde. Gibt einen negativen Wert zurück, wenn die serielle Schnittstelle nicht geöffnet werden konnte und ein Fehler in stderr ausgegeben wird.

CloseDevice​

void CloseDevice()

Mit dieser Funktion wird die serielle Schnittstelle geschlossen.

Wird vom Destruktor aufgerufen und kann unter den meisten Umständen sicher ignoriert werden.

Verfügbar​

int Verfügbar()

Diese Funktion gibt die Anzahl der Bytes zurück, die von der seriellen Schnittstelle gelesen werden können.

Rückgabe​

Die Anzahl der Bytes, die zum Lesen von der seriellen Schnittstelle zur Verfügung stehen.

WriteBytes​

void WriteBytes( const char * data, size_t size)

Diese Funktion schreibt die angegebenen Daten an die serielle Schnittstelle.

Parameter​

  • data Die Daten, die an die serielle Schnittstelle geschrieben werden sollen.

  • size Die Größe der Daten, die an die serielle Schnittstelle geschrieben werden sollen.