public

Inheritance Graph

graph BT
	SerialProvider
	SerialProvider --> AbstractFSProvider
	click SerialProvider "classUtil_1_1SerialProvider"
	click AbstractFSProvider "classUtil_1_1AbstractFSProvider"

Description

Access the the serial port using a file system provider.

serial://ComportName:BaudRate(*9600*):Parity(n...*none*|o..odd|e..even):Stopbits(*1*|2):flowcontrol(n..*none*|s..software|h..hardware)

e.g.: serial://com2 serial://com20:14400:n:2:h serial://com1:115200:::s

[ SerialProvider ] > [ AbstractFSProvider ]

Public Static Functions

   
   
bool init()

Public Functions

   
   
  SerialProvider()
   
  ~SerialProvider()
   
std::unique_ptr< std::iostream > open(const FileName & void)
   
std::unique_ptr< std::istream > openForReading(const FileName & void)
   
std::unique_ptr< std::ostream > openForWriting(const FileName & void)
   
bool isFile(const FileName & void)
   
status_t writeFile(const FileName & void, const std::vector< uint8_t > & void, bool void)

Documentation

function
Util::SerialProvider::init

public static
   
   
bool init( )

Defined in Util/IO/SerialProvider.h:36

function
Util::SerialProvider::SerialProvider

public inline
   
   
SerialProvider( )

Defined in Util/IO/SerialProvider.h:39

function
Util::SerialProvider::~SerialProvider

public inline virtual
   
   
~SerialProvider( )

Defined in Util/IO/SerialProvider.h:40

function
Util::SerialProvider::open

public virtual
     
     
std::unique_ptr< std::iostream > open( const FileName & void )

Defined in Util/IO/SerialProvider.h:42

function
Util::SerialProvider::openForReading

public virtual
     
     
std::unique_ptr< std::istream > openForReading( const FileName & void )

Defined in Util/IO/SerialProvider.h:43

function
Util::SerialProvider::openForWriting

public virtual
     
     
std::unique_ptr< std::ostream > openForWriting( const FileName & void )

Defined in Util/IO/SerialProvider.h:44

function
Util::SerialProvider::isFile

public virtual
     
     
bool isFile( const FileName & void )

Defined in Util/IO/SerialProvider.h:46

function
Util::SerialProvider::writeFile

public virtual
     
     
status_t writeFile( const FileName & void,
  const std::vector< uint8_t > & void,
  bool void
)    

Defined in Util/IO/SerialProvider.h:49