Treehopper C++ API
Public Member Functions | Public Attributes | List of all members
Flushable Class Referenceabstract

Represents any object that has a flushable interface.

#include <Flushable.h>

Inheritance diagram for Flushable:
LedDriver ChainableShiftRegisterOutput Dm632 Dm632

Public Member Functions

 ~Flushable ()
 
virtual void flush (bool force=false)=0
 flush changed data to the port expander More...
 

Public Attributes

bool autoFlush
 Whether this interface should automatically flush new values or not. More...
 
Flushable * parent
 Gets or sets the parent flushable device (if it exists); if this property is set by this driver, it is expected that flushing the parent will also flush this device. More...
 

Constructor & Destructor Documentation

◆ ~Flushable()

~Flushable ( )
inline

Member Function Documentation

◆ flush()

virtual void flush ( bool  force = false)
pure virtual
Parameters
[in]forcewhether to flush all data to the port expander, even if it doesn't appear to have been changed

Implemented in ChainableShiftRegisterOutput, and Dm632.

Member Data Documentation

◆ autoFlush

bool autoFlush

◆ parent

Flushable* parent

This property is designed to make LED displays, which operate across groups of LEDs (and possibly groups of LED drivers), much more efficient to update. Many commonly-used LED drivers are shift registers that are chained together; since these cannot be individually addressed, any write to one must include a write to all the other ones. By properly setting the parent shift register in each chain, displays can optimize these updates.

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