Documentation
Tools for embedded systems
Loading...
Searching...
No Matches
qlibs::transportDelay< numberOfDelays > Class Template Reference

Delays the input by a specified amount of time. You can use this class to simulate a time delay. More...

#include <ltisys.hpp>

Public Member Functions

 transportDelay (const real_t initValue=0.0_re)
 Constructor for the transportDelay class.
 
real_t operator() (const real_t xInput) noexcept
 Delays the input by a specified amount of time.
 

Detailed Description

template<size_t numberOfDelays>
class qlibs::transportDelay< numberOfDelays >

Delays the input by a specified amount of time. You can use this class to simulate a time delay.

See also
delayFromTime
Template Parameters
numberOfDelayThe number of discrete delays to be used. Use the delayFromTime() function to determine the number of discrete delays required for a specified amount of time. Example :
transportDelay<delayFromTime( 2.5f, dt )> myDelay1;
Delays the input by a specified amount of time. You can use this class to simulate a time delay.
Definition ltisys.hpp:112
constexpr size_t delayFromTime(const real_t Time, const real_t dt)
Computes the number of discrete delays required for a specified amount of time using a defined time-s...
Definition ltisys.hpp:94

Constructor & Destructor Documentation

◆ transportDelay()

template<size_t numberOfDelays>
qlibs::transportDelay< numberOfDelays >::transportDelay ( const real_t initValue = 0.0_re)
inline

Constructor for the transportDelay class.

Parameters
[in]initValueThe output generated by the block between the start of the simulation and the Time delay.

Member Function Documentation

◆ operator()()

template<size_t numberOfDelays>
real_t qlibs::transportDelay< numberOfDelays >::operator() ( const real_t xInput)
inlinenoexcept

Delays the input by a specified amount of time.

Parameters
[in]xInputThe signal to be delayed.
Returns
The delayed input signal