Dataflow Runtime API  3.1.1.0
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP Class Reference

Initiates interrupt based I2C communication. More...

#include <Imt.Base.Dff.ActiveParts.STM32F103HD/I2C/I2CTransactionHandlerAP.h>

Inheritance diagram for imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP:
imt::base::dff::activeparts::ActivePartAbs imt::base::dff::runtime::ExecutableIfc imt::base::dff::runtime::TimerServiceIfc

Public Member Functions

 I2CTransactionHandlerAP (const imt::base::dff::runtime::RuntimePriority::Id priority, const I2C_ModuleAddress moduleAddress, I2CTransactionQueueIfc &transactionQueue, I2CResetCallbackIfc &resetCallback)
 Constructor. More...
 
virtual ~I2CTransactionHandlerAP (void)
 Destructor. More...
 
virtual void execute (const uint16_t protocolIdentifier, imt::base::core::serialization::Deserializer &deserializer)
 
- Public Member Functions inherited from imt::base::dff::activeparts::ActivePartAbs
 ActivePartAbs (const imt::base::dff::runtime::RuntimePriority::Id priority, const imt::base::dff::runtime::ExecutableConfiguration executableConfiguration=imt::base::dff::runtime::ExecutableConfiguration())
 Constructor. More...
 
virtual ~ActivePartAbs (void)
 Destructor. More...
 
virtual const imt::base::dff::runtime::ExecutableConfigurationgetExecutableConfiguration (void) const
 
virtual imt::base::dff::runtime::RuntimePriority::Id getPriority (void) const
 
void initialize (void)
 Initialize the active part. More...
 
void start (void)
 Start the active part. More...
 
bool isInitialized (void) const
 Check if active part is initialized. More...
 
bool isStarted (void) const
 Check if active part is started. More...
 
virtual void startOneShotTimer (imt::base::dff::runtime::RuntimeTimer::TimerHandle &timerToStart, const uint32_t timerTicksMs) const
 Starts or restarts the given one shot timer for this active part. More...
 
virtual void startPeriodicTimer (imt::base::dff::runtime::RuntimeTimer::TimerHandle &timerToStart, const uint32_t intervalMs) const
 Start a periodic timer for this active part. More...
 
virtual void killTimer (imt::base::dff::runtime::RuntimeTimer::TimerHandle &timerToKill) const
 Kill the given timer (if required). More...
 
- Public Member Functions inherited from imt::base::dff::runtime::ExecutableIfc
virtual ~ExecutableIfc (void)
 Destructor. More...
 
- Public Member Functions inherited from imt::base::dff::runtime::TimerServiceIfc
virtual ~TimerServiceIfc (void)
 Destructor. More...
 

Public Attributes

PortOutput PortOut
 Ports of the active part. More...
 
- Public Attributes inherited from imt::base::dff::activeparts::ActivePartAbs
const PortInputPortIn
 Input Port of the active part (as a public visible read-only reference). More...
 

Protected Member Functions

virtual void onInitialize (void)
 
virtual void onStart (void)
 

Detailed Description

Initiates interrupt based I2C communication.

Due to STM32F103 specific errata most of the logic has to be in the event interrupt handler.

Constructor & Destructor Documentation

◆ I2CTransactionHandlerAP()

imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::I2CTransactionHandlerAP ( const imt::base::dff::runtime::RuntimePriority::Id  priority,
const I2C_ModuleAddress  moduleAddress,
I2CTransactionQueueIfc transactionQueue,
I2CResetCallbackIfc resetCallback 
)
explicit

Constructor.

◆ ~I2CTransactionHandlerAP()

virtual imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::~I2CTransactionHandlerAP ( void  )
virtual

Destructor.

Member Function Documentation

◆ execute()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::execute ( const uint16_t  protocolIdentifier,
imt::base::core::serialization::Deserializer deserializer 
)
virtual
See also
ExecutableIfc

Implements imt::base::dff::runtime::ExecutableIfc.

◆ onInitialize()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::onInitialize ( void  )
protectedvirtual

◆ onStart()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::onStart ( void  )
protectedvirtual

Member Data Documentation

◆ PortOut

PortOutput imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionHandlerAP::PortOut

Ports of the active part.


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