Dataflow Runtime API  3.0.3.0
Static Public Member Functions | List of all members
imt::base::bsp::Application Class Reference

The application class provides access to all modules. More...

#include <Imt.Base.BSP/Application.h>

Static Public Member Functions

static void initialize (void)
 Initialize the application. More...
 
static void clear (void)
 Clear the application. More...
 
static void run (imt::base::dff::activeparts::ActivePartContainerAbs &app)
 Enables all peripheral interrupts and runs the given application. More...
 
template<typename DRIVER >
static DRIVER * getDriver (const size_t indexModule, const size_t indexDriver)
 Gets the driver with the given index. More...
 
template<typename MODULE >
static MODULE * getModule (const imt::base::bsp::type::DriverType::Id type, const size_t indexModule)
 Gets the module with the given index. More...
 
static size_t getNumberOfDrivers (const imt::base::bsp::type::DriverType::Id type, const size_t indexModule)
 Gets the number of avaliable drivers in a certain module. More...
 
static size_t getNumberOfModules (const imt::base::bsp::type::DriverType::Id type)
 Gets the number of avaliable modules of a certain type. More...
 
static void * getModulesTcpClient (const imt::base::bsp::type::DriverType::Id type, const size_t indexModule, const size_t indexDriver)
 Gets the number of avaliable modules of a certain type. More...
 

Detailed Description

The application class provides access to all modules.

Member Function Documentation

◆ clear()

static void imt::base::bsp::Application::clear ( void  )
static

Clear the application.

This will delete all the module and driver instances.

◆ getDriver()

template<typename DRIVER >
static DRIVER* imt::base::bsp::Application::getDriver ( const size_t  indexModule,
const size_t  indexDriver 
)
inlinestatic

Gets the driver with the given index.

Parameters
indexModuleThe index of the module, starting at 0 for the first one.
indexDriverThe index of the driver, starting at 0 for the first one.
Returns
The driver or a null pointer of not supported for this BSP.

◆ getModule()

template<typename MODULE >
static MODULE* imt::base::bsp::Application::getModule ( const imt::base::bsp::type::DriverType::Id  type,
const size_t  indexModule 
)
inlinestatic

Gets the module with the given index.

Parameters
typeThe type of driver.
indexModuleThe index of the module, starting at 0 for the first one.
Returns
The module or a null pointer of not supported for this BSP.

◆ getModulesTcpClient()

static void* imt::base::bsp::Application::getModulesTcpClient ( const imt::base::bsp::type::DriverType::Id  type,
const size_t  indexModule,
const size_t  indexDriver 
)
static

Gets the number of avaliable modules of a certain type.

(Note: Implementation only applicable for simulation BSP, other BSPs to always return NULL.)

Parameters
typeThe type of drivers the module provides.
indexModuleThe index of the module to return, starting at 0 for the first one.
indexDriverThe index of the driver to return, starting at 0 for the first one.
Returns
Non-null void type pointer (if valid), else null (or, not supported).

◆ getNumberOfDrivers()

static size_t imt::base::bsp::Application::getNumberOfDrivers ( const imt::base::bsp::type::DriverType::Id  type,
const size_t  indexModule 
)
static

Gets the number of avaliable drivers in a certain module.

Parameters
typeThe type of driver.
indexModuleThe index of the module, starting at 0 for the first one.
Returns
The number of drivers.

◆ getNumberOfModules()

static size_t imt::base::bsp::Application::getNumberOfModules ( const imt::base::bsp::type::DriverType::Id  type)
static

Gets the number of avaliable modules of a certain type.

Parameters
typeThe type of driver.
Returns
The number of modules.

◆ initialize()

static void imt::base::bsp::Application::initialize ( void  )
static

Initialize the application.

This will setup clocks, pin configuration and init all avaliable peripherals.

◆ run()

static void imt::base::bsp::Application::run ( imt::base::dff::activeparts::ActivePartContainerAbs app)
static

Enables all peripheral interrupts and runs the given application.

This method will never return.

Parameters
appThe application top level container.

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