trikRuntime
Signals | Public Member Functions | List of all members
trikHal::EventFileInterface Class Referenceabstract

Event file abstraction. Can be opened or closed, when opened can emit signal containing event data. More...

#include <eventFileInterface.h>

Inheritance diagram for trikHal::EventFileInterface:
Inheritance graph
[legend]
Collaboration diagram for trikHal::EventFileInterface:
Collaboration graph
[legend]

Signals

void newEvent (int eventType, int code, int value, const trikKernel::TimeVal &eventTime)
 Emitted when there is new event in an event file. More...
 

Public Member Functions

virtual bool open ()=0
 Opens event file and starts listening for events. More...
 
virtual bool close ()=0
 Closes event file and stops listening for events. More...
 
virtual void cancelWaiting ()=0
 Abort all pending synchronous event loops. More...
 
virtual QString fileName () const =0
 Returns name of an event file. More...
 
virtual bool isOpened () const =0
 Returns true if a file is opened. More...
 

Detailed Description

Event file abstraction. Can be opened or closed, when opened can emit signal containing event data.

Member Function Documentation

virtual void trikHal::EventFileInterface::cancelWaiting ( )
pure virtual

Abort all pending synchronous event loops.

Implemented in trikHal::trik::TrikEventFile, and trikHal::stub::StubEventFile.

virtual bool trikHal::EventFileInterface::close ( )
pure virtual

Closes event file and stops listening for events.

Implemented in trikHal::trik::TrikEventFile, and trikHal::stub::StubEventFile.

virtual QString trikHal::EventFileInterface::fileName ( ) const
pure virtual

Returns name of an event file.

Implemented in trikHal::trik::TrikEventFile, and trikHal::stub::StubEventFile.

virtual bool trikHal::EventFileInterface::isOpened ( ) const
pure virtual

Returns true if a file is opened.

Implemented in trikHal::trik::TrikEventFile, and trikHal::stub::StubEventFile.

void trikHal::EventFileInterface::newEvent ( int  eventType,
int  code,
int  value,
const trikKernel::TimeVal &  eventTime 
)
signal

Emitted when there is new event in an event file.

Parameters
eventType- low-level type of an event.
code- low-level event code.
value- low-level event value.
virtual bool trikHal::EventFileInterface::open ( )
pure virtual

Opens event file and starts listening for events.

Implemented in trikHal::trik::TrikEventFile, and trikHal::stub::StubEventFile.

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