Dataflow Runtime API  3.0.3.0
Public Member Functions | Protected Member Functions | List of all members
imt::base::bsp::module::PwmModule Class Reference

Module that contains a number of GPIO pins that are provided as driver instances. More...

#include <Imt.Base.BSP/Module/PwmModule.h>

Inheritance diagram for imt::base::bsp::module::PwmModule:
imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::PwmDriver, imt::base::bsp::type::DriverType::PWM >

Public Member Functions

 PwmModule (const size_t indexModule)
 Constructor. More...
 
virtual ~PwmModule (void)
 Destructor. More...
 
- Public Member Functions inherited from imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::PwmDriver, imt::base::bsp::type::DriverType::PWM >
 ModuleAbs (const size_t indexModule, const size_t numberOfModules, const size_t numberOfDrivers)
 Constructor. More...
 
virtual ~ModuleAbs (void)
 Destructor. More...
 
void initialize (void)
 Initialize the module and all drivers. More...
 
void enable (void)
 Enable the module (but not its drivers). More...
 
imt::base::bsp::type::ErrorCode::Id start (void)
 Starts the module. More...
 
imt::base::bsp::type::ErrorCode::Id stop (void)
 Stops the module. More...
 
imt::base::bsp::driver::PwmDrivergetDriver (const size_t indexDriver)
 Gets the given driver. More...
 
size_t getIndexModule (void) const
 Gets the index of the module. More...
 
size_t getNumberOfDrivers (void) const
 Gets the number of drivers provided by this module. More...
 
imt::base::bsp::type::DriverType::Id getType (void) const
 Gets the type of the module. More...
 
bool isInitialized (void) const
 Gets if the module has been initialzied. More...
 
bool isEnabled (void) const
 Gets if the module has been enabled. More...
 
bool isStarted (void) const
 Gets if the module has been started. More...
 

Protected Member Functions

virtual void onInitialize (void)
 
virtual void onEnable (void)
 
virtual imt::base::bsp::type::ErrorCode::Id onStart (void)
 
virtual imt::base::bsp::type::ErrorCode::Id onStop (void)
 

Additional Inherited Members

- Static Public Attributes inherited from imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::PwmDriver, imt::base::bsp::type::DriverType::PWM >
static const imt::base::bsp::type::DriverType::Id Type
 Constant holding the driver type. More...
 

Detailed Description

Module that contains a number of GPIO pins that are provided as driver instances.

Constructor & Destructor Documentation

◆ PwmModule()

imt::base::bsp::module::PwmModule::PwmModule ( const size_t  indexModule)
explicit

Constructor.

Parameters
indexModuleIndex of the module (starting at 0).

◆ ~PwmModule()

virtual imt::base::bsp::module::PwmModule::~PwmModule ( void  )
virtual

Destructor.

Member Function Documentation

◆ onEnable()

virtual void imt::base::bsp::module::PwmModule::onEnable ( void  )
protectedvirtual

◆ onInitialize()

virtual void imt::base::bsp::module::PwmModule::onInitialize ( void  )
protectedvirtual

◆ onStart()

virtual imt::base::bsp::type::ErrorCode::Id imt::base::bsp::module::PwmModule::onStart ( void  )
protectedvirtual

◆ onStop()

virtual imt::base::bsp::type::ErrorCode::Id imt::base::bsp::module::PwmModule::onStop ( void  )
protectedvirtual

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