ConOpSys V2970  P004.07
ANVILEX control operating system
Public Member Functions | List of all members
TTIMER5_STM32F410CBU6 Class Reference

System timer class. More...

#include <TIMER5_STM32F410CBU6.h>

Inheritance diagram for TTIMER5_STM32F410CBU6:
Inheritance graph
Collaboration diagram for TTIMER5_STM32F410CBU6:
Collaboration graph

Public Member Functions

virtual BOOL Configure_Clock (U32 u32_Clock)
 Set timer input clock frequency method. More...
 
virtual VOID Interrupt_Enable (U32 u32_Interrupt_Priority)
 Enable interrupt method. More...
 
virtual VOID Interrupt_Disable ()
 Disable interrupt method. More...
 
virtual VOID Start ()
 Start timer operation method. More...
 
virtual VOID Stop ()
 Stop timer operation method. More...
 
virtual U32 Get_Actual_Time ()
 Get actual time in counts method. More...
 
virtual U64 Get_Actual_Time_U64 ()
 Get actual time in counts method. More...
 
- Public Member Functions inherited from THigh_Precision_Timer_Base
VOID Delay (F32 f32_Delay_Value)
 Perform blocked delay given in s. More...
 
F32 Get_Delta_Time (U64 u64_Start_Timestamp, U64 u64_End_Timestamp)
 Get delta time in seconds. More...
 
BOOL Is_Timeout (U64 u64_Start_Timestamp, F32 f32_Timeout)
 Return statis of the timeout. More...
 
VOID Interrupt ()
 High precision timer interrupt method. More...
 
- Public Member Functions inherited from TTimer_Base
 TTimer_Base ()
 User timer class constructor method. More...
 
virtual ~TTimer_Base ()
 User timer class destructor method. More...
 
VOID Interrupt ()
 User timer interrupt method. More...
 
BOOL Set_Interrupt_Frequency (F32 f32_Frequency)
 Set user timer interrupt frequency method. More...
 
F32 Get_Resolution_s ()
 Get timer resolution in seconds. More...
 
F32 Get_Resolution_ms ()
 Get timer resolution in miliseconds. More...
 
F32 Get_Resolution_us ()
 Get timer resolution in microseconds. More...
 
F32 Get_Resolution_ns ()
 Get timer resolution in nanoseconds. More...
 
F32 Get_Interrupt_Frequency ()
 Get Get interrupt frequency in herz. More...
 
F32 Get_Interrupt_Period ()
 Get interrupt period in seconds. More...
 
U32 Time_To_Execution_Loops (F32 f32_Time_Span)
 Convert time to interrupt loops method. More...
 
VOID Init ()
 User timer initialisation method. More...
 
VOID Done ()
 User timer finalisation method. More...
 

Additional Inherited Members

- Protected Attributes inherited from THigh_Precision_Timer_Base
U32 u32_Extended_Counter = (U32)0
 Extended counter. More...
 
- Protected Attributes inherited from TTimer_Base
BOOL bool_Initialisation_Error = (BOOL)false
 Initialisation error. More...
 
F32 f32_Input_Clock = (F32)0.0f
 Timer input frequency in Hz. More...
 
U32 u32_Timer_Clock = (U32)0
 Timer clock in herz. More...
 
U32 u32_Timer_Counts = (U32)0
 Timer counter preset value. More...
 
F32 f32_Resolution_s = (F32)0.0f
 Timer resolution in seconds. More...
 
F32 f32_Resolution_ms = (F32)0.0f
 Timer resolution in miliseconds. More...
 
F32 f32_Resolution_us = (F32)0.0f
 Timer resolution in microseconds. More...
 
F32 f32_Resolution_ns = (F32)0.0f
 Timer resolution in nanoseconds. More...
 
F32 f32_Interrupt_Frequency = (F32)0.0f
 Interrupt frequency in herz. More...
 
F32 f32_Interrupt_Period = (F32)0.0f
 Interrupt period in seconds. More...
 

Detailed Description

System timer class.

High resolution timer is used for implementing of the diverse delays and time intervals.

Member Function Documentation

◆ Configure_Clock()

BOOL TTIMER5_STM32F410CBU6::Configure_Clock ( U32  u32_Clock)
virtual

Set timer input clock frequency method.


Note
None
Parameters
[in]u32_Clock- Timer input clock in herz
Returns
BOOL - Execution status
Return values
false- Execution without errors
true- Execution without any errors
Override
Optional
Attention
None

Reimplemented from TTimer_Base.

References TTimer_Base::Configure_Clock().

Here is the call graph for this function:

◆ Get_Actual_Time()

U32 TTIMER5_STM32F410CBU6::Get_Actual_Time ( )
virtual

Get actual time in counts method.


Note
None
Returns
U32 - Actual time in counts.
Override
Not allowed
Attention
None

◆ Get_Actual_Time_U64()

U64 TTIMER5_STM32F410CBU6::Get_Actual_Time_U64 ( )
virtual

Get actual time in counts method.


Note
None
Returns
U64 - Actual time in counts.
Override
Not allowed
Attention
None

Implements THigh_Precision_Timer_Base.

References Compose_U64(), Maximum_U64(), and THigh_Precision_Timer_Base::u32_Extended_Counter.

Here is the call graph for this function:

◆ Interrupt_Disable()

VOID TTIMER5_STM32F410CBU6::Interrupt_Disable ( )
virtual

Disable interrupt method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TTimer_Base.

◆ Interrupt_Enable()

VOID TTIMER5_STM32F410CBU6::Interrupt_Enable ( U32  u32_Interrupt_Priority)
virtual

Enable interrupt method.


Note
None
Parameters
[in]u32_Interrupt_Priority- Timer inperrupt priority
Returns
None
Override
Not allowed
Attention
None

Implements TTimer_Base.

◆ Start()

VOID TTIMER5_STM32F410CBU6::Start ( )
virtual

Start timer operation method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TTimer_Base.

◆ Stop()

VOID TTIMER5_STM32F410CBU6::Stop ( )
virtual

Stop timer operation method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TTimer_Base.


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