Bela
Real-time, ultra-low-latency audio and sensor processing system for BeagleBone Black
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Public Member Functions | List of all members
ShiftRegisterIn Class Reference
Inheritance diagram for ShiftRegisterIn:
ShiftRegister

Public Member Functions

bool dataReceived ()
 
const std::vector< bool > & getData ()
 
void process (BelaContext *context, unsigned int n) override
 
- Public Member Functions inherited from ShiftRegister
 ShiftRegister ()
 
 ShiftRegister (const Pins &pins, unsigned int maxSize)
 
void setup (const Pins &pins, unsigned int maxSize)
 
bool dataReady ()
 

Additional Inherited Members

- Protected Types inherited from ShiftRegister
enum  State { kStart, kTransmitting, kStop, kIdle }
 
- Protected Attributes inherited from ShiftRegister
Pins pins
 
State state = kStop
 
std::vector< bool > data
 
bool pinModeSet = false
 
bool notified = true
 

Member Function Documentation

bool ShiftRegisterIn::dataReceived ( )

Check whether there is data that has been shifted in and the transmission has completed.

Returns
true if the last transmission has completed and the data is ready to be accessed via getData().
const std::vector< bool > & ShiftRegisterIn::getData ( )

Get the data that has been shifted in. This is only guaranteed to contain the complete content of a transmission if it is called in the same frame as dataReceived() returns true.

Returns
the incoming data.
void ShiftRegisterIn::process ( BelaContext context,
unsigned int  n 
)
overridevirtual

Shift I/O data for frame n.

Implements ShiftRegister.


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