LibLogicalAccess  2.5.0
An Open Source RFID Library
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
logicalaccess::STidSTRLEDBuzzerDisplay Class Reference

A STidSTR LED/Buzzer Display class. More...

#include <stidstrledbuzzerdisplay.hpp>

Inheritance diagram for logicalaccess::STidSTRLEDBuzzerDisplay:
logicalaccess::LEDBuzzerDisplay

Public Member Functions

 STidSTRLEDBuzzerDisplay ()
 Constructor.
 
void setGreenLed (bool status) override
 Set the green led to a status.
 
void setRedLed (bool status) override
 Set the red led to a status.
 
void setBuzzer (bool status) override
 Set the buzzer to a status.
 
void setRedLed (bool status, bool deferred)
 Set the red led status.
 
void setGreenLed (bool status, bool deferred)
 Set the green led status.
 
void setBuzzer (bool status, bool deferred)
 Set the buzzer status.
 
void setPort () const
 Upload led and buzzer status.
 
void setPort (bool red, bool green, bool buzzer)
 Upload led and buzzer status.
 
std::shared_ptr< STidSTRReaderCardAdaptergetSTidSTRReaderCardAdapter () const
 
- Public Member Functions inherited from logicalaccess::LEDBuzzerDisplay
virtual ~LEDBuzzerDisplay ()=default
 
virtual void setGreenLed (bool status)=0
 Set the green led to a status.
 
virtual void setRedLed (bool status)=0
 Set the red led to a status.
 
virtual void setBuzzer (bool status)=0
 Set the buzzer to a status.
 
std::shared_ptr< ReaderCardAdaptergetReaderCardAdapter () const
 Get the reader card adapter.
 
void setReaderCardAdapter (std::shared_ptr< ReaderCardAdapter > adapter)
 Set the reader card adapter.
 

Protected Attributes

bool d_red_led
 The red led status.
 
bool d_green_led
 The green led status.
 
bool d_buzzer
 The buzzer status.
 
- Protected Attributes inherited from logicalaccess::LEDBuzzerDisplay
std::shared_ptr< ReaderCardAdapterd_readerCardAdapter
 The reader card adapter.
 

Detailed Description

A STidSTR LED/Buzzer Display class.

Constructor & Destructor Documentation

◆ STidSTRLEDBuzzerDisplay()

logicalaccess::STidSTRLEDBuzzerDisplay::STidSTRLEDBuzzerDisplay ( )

Constructor.

Member Function Documentation

◆ getSTidSTRReaderCardAdapter()

std::shared_ptr< STidSTRReaderCardAdapter > logicalaccess::STidSTRLEDBuzzerDisplay::getSTidSTRReaderCardAdapter ( ) const
inline

◆ setBuzzer() [1/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setBuzzer ( bool  status)
overridevirtual

Set the buzzer to a status.

Parameters
statusTrue to play the buzzer, false otherwise.

Implements logicalaccess::LEDBuzzerDisplay.

◆ setBuzzer() [2/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setBuzzer ( bool  status,
bool  deferred 
)

Set the buzzer status.

Parameters
statustrue if the buzzer must be turned on, false if it must be turned down.
deferredif set to true, the buzzer status won't be changed until the next call to setPort() or the next call to setRedLed(), setGreenLed() or setBuzzer() with the deferred parameter set to false. Default is false.

◆ setGreenLed() [1/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setGreenLed ( bool  status)
overridevirtual

Set the green led to a status.

Parameters
statusTrue to show the green led, false otherwise.

Implements logicalaccess::LEDBuzzerDisplay.

◆ setGreenLed() [2/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setGreenLed ( bool  status,
bool  deferred 
)

Set the green led status.

Parameters
statustrue if the led must be switched on, false if it must be switched down.
deferredif set to true, the led status won't be changed until the next call to setPort() or the next call to setRedLed(), setGreenLed() or setBuzzer() with the deferred parameter set to false. Default is false.

◆ setPort() [1/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setPort ( ) const

Upload led and buzzer status.

See also
setRedLed
setGreenLed
setBuzzer

◆ setPort() [2/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setPort ( bool  red,
bool  green,
bool  buzzer 
)

Upload led and buzzer status.

Parameters
redThe red led status.
greenThe green led status.
buzzerThe buzzer status.
See also
setRedLed
setGreenLed
setBuzzer

◆ setRedLed() [1/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setRedLed ( bool  status)
overridevirtual

Set the red led to a status.

Parameters
statusTrue to show the red led, false otherwise.

Implements logicalaccess::LEDBuzzerDisplay.

◆ setRedLed() [2/2]

void logicalaccess::STidSTRLEDBuzzerDisplay::setRedLed ( bool  status,
bool  deferred 
)

Set the red led status.

Parameters
statustrue if the led must be switched on, false if it must be switched down.
deferredif set to true, the led status won't be changed until the next call to setPort() or the next call to setRedLed(), setGreenLed() or setBuzzer() with the deferred parameter set to false. Default is false.

Member Data Documentation

◆ d_buzzer

bool logicalaccess::STidSTRLEDBuzzerDisplay::d_buzzer
protected

The buzzer status.

◆ d_green_led

bool logicalaccess::STidSTRLEDBuzzerDisplay::d_green_led
protected

The green led status.

◆ d_red_led

bool logicalaccess::STidSTRLEDBuzzerDisplay::d_red_led
protected

The red led status.


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