imt::base::bsp::module::AdcModule Class Reference

Module that contains a number of ADC channels that are provided as driver instances. More...

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

Inheritance diagram for imt::base::bsp::module::AdcModule:

Public Member Functions
	AdcModule (const size_t indexModule)
	Constructor. More...
virtual	~AdcModule (void)
	Destructor. More...
imt::base::bsp::type::ErrorCode::Id	calibrate (void)
	Calibrates all ADC channels in this module. More...
Public Member Functions inherited from imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::AdcDriver, imt::base::bsp::type::DriverType::ADC >
	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::AdcDriver *	getDriver (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::AdcDriver, imt::base::bsp::type::DriverType::ADC >
static const imt::base::bsp::type::DriverType::Id	Type
	Constant holding the driver type. More...

Detailed Description

Module that contains a number of ADC channels that are provided as driver instances.

Constructor & Destructor Documentation

AdcModule()

imt::base::bsp::module::AdcModule::AdcModule ( const size_t  indexModule )

explicit

Constructor.

Parameters

indexModule

Index of the module (starting at 0).

~AdcModule()

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

virtual

Destructor.

Member Function Documentation

calibrate()

imt::base::bsp::type::ErrorCode::Id imt::base::bsp::module::AdcModule::calibrate

(

void

)

Calibrates all ADC channels in this module.

Returns

True if the configuration was successful, false otherwise.

onEnable()

virtual void imt::base::bsp::module::AdcModule::onEnable ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::AdcDriver, imt::base::bsp::type::DriverType::ADC >.

onInitialize()

virtual void imt::base::bsp::module::AdcModule::onInitialize ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::AdcDriver, imt::base::bsp::type::DriverType::ADC >.

onStart()

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

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::AdcDriver, imt::base::bsp::type::DriverType::ADC >.

onStop()

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

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::ModuleAbs< imt::base::bsp::driver::AdcDriver, imt::base::bsp::type::DriverType::ADC >.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.BSP/Module/AdcModule.h