Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::plugin::spidmx::SPIDMXThread Class Reference
Inheritance diagram for ola::plugin::spidmx::SPIDMXThread:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::spidmx::SPIDMXThread:
Collaboration graph
[legend]

Public Member Functions

 SPIDMXThread (SPIDMXWidget *widget, unsigned int blocklength)
 
void RegisterPort ()
 
void UnregisterPort ()
 
bool Stop ()
 
void * Run ()
 
bool WriteDMX (const DmxBuffer &buffer)
 
const DmxBufferGetDmxInBuffer () const
 Get DMX Buffer. More...
 
bool SetReceiveCallback (Callback0< void > *callback)
 Set the callback to be called when the receive buffer is updated. More...
 
- Public Member Functions inherited from ola::thread::Thread
 Thread (const Options &options=Options())
 Create a new thread with the specified thread options. More...
 
virtual ~Thread ()
 Destructor.
 
virtual bool Start ()
 Start the thread and wait for the thread to be running. More...
 
virtual bool FastStart ()
 Start the thread and return immediately. More...
 
virtual bool Join (void *ptr=NULL)
 Join this thread. More...
 
bool IsRunning ()
 Check if the thread is running. More...
 
ThreadId Id () const
 Return the thread id. More...
 
std::string Name () const
 Return the thread name. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ola::thread::Thread
static ThreadId Self ()
 Returns the current thread's id. More...
 

Member Function Documentation

const DmxBuffer & ola::plugin::spidmx::SPIDMXThread::GetDmxInBuffer ( ) const

Get DMX Buffer.

Returns
DmxBuffer with current input values.
void ola::plugin::spidmx::SPIDMXThread::RegisterPort ( )

This thread only has to run if ports using it are patched to a universe. Thus, they must register and unregister to notify this thread.

void * ola::plugin::spidmx::SPIDMXThread::Run ( )
virtual

The method called by the thread

Implements ola::thread::Thread.

bool ola::plugin::spidmx::SPIDMXThread::SetReceiveCallback ( Callback0< void > *  callback)

Set the callback to be called when the receive buffer is updated.

Parameters
callbackThe callback to call or NULL to unregister.
Returns
false if there was an error, true otherwise.
bool ola::plugin::spidmx::SPIDMXThread::Stop ( )

Stop this thread

bool ola::plugin::spidmx::SPIDMXThread::WriteDMX ( const DmxBuffer buffer)

Copy a DmxBuffer to the output thread


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