Flair
Framework Libre Air
flair::core::SerialPort Class Referenceabstract

Base class for serial port. More...

#include <SerialPort.h>

+ Inheritance diagram for flair::core::SerialPort:

Public Member Functions

 SerialPort (const Object *parent, std::string name)
 Constructor. More...
 
 ~SerialPort ()
 Destructor. More...
 
virtual void SetBaudrate (int baudrate)=0
 Set baudrate. More...
 
virtual void SetRxTimeout (Time timeout_ns)=0
 Set RX timeout. More...
 
virtual ssize_t Write (const void *buf, size_t nbyte)=0
 Write datas. More...
 
virtual ssize_t Read (void *buf, size_t nbyte)=0
 Read datas. More...
 
virtual void FlushInput (void)=0
 Flush input datas. More...
 
- Public Member Functions inherited from flair::core::Object
 Object (const Object *parent=NULL, std::string name="", std::string type="")
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
std::string ObjectName (void) const
 Name. More...
 
std::string ObjectType (void) const
 Type. More...
 
const ObjectParent (void) const
 Parent. More...
 
std::vector< const Object * > * TypeChilds (void) const
 Childs of the same type. More...
 
std::vector< const Object * > * Childs (void) const
 Childs. More...
 
void Information (const char *function, int line, const char *format,...) const
 Formatted information. More...
 
void Warning (const char *function, const char *format,...) const
 Formatted warning. More...
 
void Error (const char *function, const char *format,...) const
 Formatted error. More...
 
bool ErrorOccured (bool recursive=true) const
 Has an errror occured? More...
 

Additional Inherited Members

- Public Types inherited from flair::core::Object
enum  color_t { Auto = 0, Red = 31, Green = 32, Orange = 33 }
 

Detailed Description

Base class for serial port.

Constructor & Destructor Documentation

flair::core::SerialPort::SerialPort ( const Object parent,
std::string  name 
)
inline

Constructor.

Construct a serial port.

Parameters
parentparent
namename
flair::core::SerialPort::~SerialPort ( )
inline

Destructor.

Member Function Documentation

virtual void flair::core::SerialPort::SetBaudrate ( int  baudrate)
pure virtual

Set baudrate.

Parameters
baudratebaudrate

Implemented in flair::core::RTDM_SerialPort, and flair::core::Unix_SerialPort.

virtual void flair::core::SerialPort::SetRxTimeout ( Time  timeout_ns)
pure virtual

Set RX timeout.

Timeout for waiting datas.

Parameters
timeout_nstimeout in nano second

Implemented in flair::core::RTDM_SerialPort, and flair::core::Unix_SerialPort.

virtual ssize_t flair::core::SerialPort::Write ( const void *  buf,
size_t  nbyte 
)
pure virtual

Write datas.

Parameters
bufpointer to datas
nbytelength of datas
Returns
amount of written datas

Implemented in flair::core::RTDM_SerialPort, and flair::core::Unix_SerialPort.

virtual ssize_t flair::core::SerialPort::Read ( void *  buf,
size_t  nbyte 
)
pure virtual

Read datas.

Parameters
bufpointer to datas
nbytelength of datas
Returns
amount of read datas

Implemented in flair::core::RTDM_SerialPort, and flair::core::Unix_SerialPort.

virtual void flair::core::SerialPort::FlushInput ( void  )
pure virtual

Flush input datas.

Implemented in flair::core::RTDM_SerialPort, and flair::core::Unix_SerialPort.