TwiceAsNice  2019-02-18
Public Member Functions | Private Attributes | List of all members
basda::gentec::ChatSerialLine Class Reference

This SerialLine uses the ChatLine class from Nice. More...

#include <ChatSerialLine.hpp>

Inheritance diagram for basda::gentec::ChatSerialLine:
Inheritance graph
Collaboration diagram for basda::gentec::ChatSerialLine:
Collaboration graph

Public Member Functions

 ChatSerialLine (const std::string &deviceLocation)
 
virtual ~ChatSerialLine ()
 
virtual unsigned write (const std::string &message)
 
virtual std::string readLine ()
 
void init ()
 
 ChatSerialLine (const std::string &deviceLocation)
 
virtual ~ChatSerialLine ()
 
virtual unsigned write (const std::string &message)
 
virtual std::string readLine ()
 
void init ()
 
- Public Member Functions inherited from basda::gentec::SerialLine
virtual ~SerialLine ()
 
virtual ~SerialLine ()
 

Private Attributes

std::string deviceLocation_
 
bool initialized_
 
Nice::ChatLine chatter_
 

Detailed Description

This SerialLine uses the ChatLine class from Nice.

Constructor & Destructor Documentation

◆ ChatSerialLine() [1/2]

basda::gentec::ChatSerialLine::ChatSerialLine ( const std::string &  deviceLocation)
explicit
Precondition
deviceLocation must not be empty

◆ ~ChatSerialLine() [1/2]

basda::gentec::ChatSerialLine::~ChatSerialLine ( )
virtual
Note
overridden

◆ ChatSerialLine() [2/2]

basda::gentec::ChatSerialLine::ChatSerialLine ( const std::string &  deviceLocation)
explicit
Precondition
deviceLocation must not be empty

◆ ~ChatSerialLine() [2/2]

virtual basda::gentec::ChatSerialLine::~ChatSerialLine ( )
virtual
Note
overridden

Member Function Documentation

◆ init() [1/2]

void basda::gentec::ChatSerialLine::init ( )
Exceptions
Nice::ChatExceptionif communication setup fails

◆ init() [2/2]

void basda::gentec::ChatSerialLine::init ( )
Exceptions
Nice::ChatExceptionif communication setup fails

◆ readLine() [1/2]

virtual std::string basda::gentec::ChatSerialLine::readLine ( )
virtual
Note
overridden
Precondition
object must be initialized

Implements basda::gentec::SerialLine.

◆ readLine() [2/2]

std::string basda::gentec::ChatSerialLine::readLine ( )
virtual
Note
overridden
Precondition
object must be initialized

Implements basda::gentec::SerialLine.

◆ write() [1/2]

virtual unsigned basda::gentec::ChatSerialLine::write ( const std::string &  message)
virtual
Note
overridden
Precondition
object must be initialized

Implements basda::gentec::SerialLine.

◆ write() [2/2]

unsigned basda::gentec::ChatSerialLine::write ( const std::string &  message)
virtual
Note
overridden
Precondition
object must be initialized

Implements basda::gentec::SerialLine.

Member Data Documentation

◆ chatter_

Nice::ChatLine basda::gentec::ChatSerialLine::chatter_
private

◆ deviceLocation_

std::string basda::gentec::ChatSerialLine::deviceLocation_
private

◆ initialized_

bool basda::gentec::ChatSerialLine::initialized_
private

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