warptwin::LatencyUtil< T > Class Template Reference

Latency model. More...

#include <LatencyUtil.hpp>

Public Member Functions
	LatencyUtil (SimulationExecutive &exc)
int	start (int latency=0, T start_val=T())
	Starting the latency model.
int	step (T input_value, T &output_value)
	Step the latency model.
int	reset ()
	Function for reseting the latency queue.

Protected Attributes
std::queue< T >	_latency_queue
	Buffer to hold latency values.
SimulationExecutive &	_exc
	Reference to the simulation executive.
clockwerk::Time	_lat_sim_rate
	Simulation rate in milliseconds.
T	_default_value
	Default value to fill the queue with.
bool	_first_run = true
	Tracks the first time the model is stepped.

Detailed Description

template<typename T>
class warptwin::LatencyUtil< T >

Latency model.

This model implements a latency mechanism that delays the output value by a specified latency.

The model uses a queue to store the input values and outputs them after a specified latency. The latency is specified in milliseconds.

Author

Will Burken will..nosp@m.burk.nosp@m.en@at.nosp@m.tx.t.nosp@m.ech

Constructor & Destructor Documentation

LatencyUtil()

template<typename T>

warptwin::LatencyUtil< T >::LatencyUtil ( SimulationExecutive & exc )

inline

Member Function Documentation

reset()

template<typename T>

int warptwin::LatencyUtil< T >::reset

(

)

Function for reseting the latency queue.

Returns

Error code corresponding to success/failure

start()

template<typename T>

int warptwin::LatencyUtil< T >::start	(	int	latency = 0,
		T	start_val = T() )

Starting the latency model.

Parameters

latency	The latency in milliseconds
start_val	The value to start the queue with

Returns

Error code corresponding to success/failure

Note

This function will fill the queue with the start value for the number of steps corresponding to the latency. The queue will be filled with the start value for the number of steps corresponding to the latency.

step()

template<typename T>

int warptwin::LatencyUtil< T >::step	(	T	input_value,
		T &	output_value )

Step the latency model.

Parameters

input_value	The input value to write to the queue
output_value	The output value to read from the queue

Returns

Error code corresponding to success/failure

Note

This function will write the input value to the queue and read the output value from the queue. The output value will be the value at the front of the queue, which will be delayed by the latency.

Member Data Documentation

_default_value

template<typename T>

T warptwin::LatencyUtil< T >::_default_value

protected

Default value to fill the queue with.

_exc

template<typename T>

SimulationExecutive& warptwin::LatencyUtil< T >::_exc

protected

Reference to the simulation executive.

_first_run

template<typename T>

bool warptwin::LatencyUtil< T >::_first_run = true

protected

Tracks the first time the model is stepped.

_lat_sim_rate

template<typename T>

clockwerk::Time warptwin::LatencyUtil< T >::_lat_sim_rate

protected

Simulation rate in milliseconds.

_latency_queue

template<typename T>

std::queue<T> warptwin::LatencyUtil< T >::_latency_queue

protected

Buffer to hold latency values.

---

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

• /Users/mickey/Documents/Projects/warptwin/cpp/src/utils/LatencyUtil.hpp