Infrared4Arduino
Public Member Functions | Protected Member Functions | List of all members
IrSender Class Referenceabstract

Abstract base class for all sending classes. More...

#include <IrSender.h>

Inheritance diagram for IrSender:
Inheritance graph
[legend]

Public Member Functions

virtual ~IrSender ()
 
virtual void send (const IrSequence &irSequence, frequency_t frequency=IrSignal::defaultFrequency)=0
 Sends an IrSequence with the prescribed frequency. More...
 
void sendIrSignal (const IrSignal &irSignal, unsigned int noSends=1)
 Sends the IrSignal given as argument the prescribed number of times. More...
 
virtual void mute ()
 Force output pin inactive. More...
 

Protected Member Functions

pin_t getOutputPin () const
 
void delayUSecs (microseconds_t T)
 
 IrSender ()
 
 IrSender (pin_t pin)
 

Detailed Description

Abstract base class for all sending classes.

Definition at line 27 of file IrSender.h.

Constructor & Destructor Documentation

IrSender::IrSender ( )
protected

Definition at line 35 of file IrSender.cpp.

IrSender::IrSender ( pin_t  pin)
protected

Definition at line 39 of file IrSender.cpp.

IrSender::~IrSender ( )
virtual

Definition at line 45 of file IrSender.cpp.

Member Function Documentation

void IrSender::delayUSecs ( microseconds_t  T)
protected

Definition at line 25 of file IrSender.cpp.

pin_t IrSender::getOutputPin ( ) const
inlineprotected

Definition at line 32 of file IrSender.h.

void IrSender::mute ( )
virtual

Force output pin inactive.

Definition at line 49 of file IrSender.cpp.

virtual void IrSender::send ( const IrSequence irSequence,
frequency_t  frequency = IrSignal::defaultFrequency 
)
pure virtual

Sends an IrSequence with the prescribed frequency.

Parameters
irSequence
frequencyfrequency in Hz

Implemented in IrSenderPwm, IrSenderNonMod, and IrSenderSimulator.

void IrSender::sendIrSignal ( const IrSignal irSignal,
unsigned int  noSends = 1 
)

Sends the IrSignal given as argument the prescribed number of times.

This will send the intro sequence signal of the IrSignal, noSend of the repeat, alternatively noSends - 1 repeats if intro is non-empty, and finally the ending sequence.

Parameters
irSignal
noSends

Definition at line 53 of file IrSender.cpp.


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