timing::Timing Class Reference

Represents a timing source for simulation. More...

#include "timing.h"

Public Member Functions
	Timing (std::string name, unsigned seed, const SimId id=0) noexcept
	Constructs a Timing object.
	~Timing ()=default
	Timing (const Timing &)=delete
Timing &	operator= (const Timing &)=delete
	Timing (Timing &&)=delete
Timing &	operator= (Timing &&)=delete
RealType	getNextSample () const noexcept
	Gets the next sample from the timing source.
std::string	getName () const noexcept
	Gets the name of the timing source.
SimId	getId () const noexcept
	Gets the unique ID of the timing source.
unsigned	getSeed () const noexcept
	Gets the initial seed used for the timing source's RNG.
bool	getSyncOnPulse () const noexcept
	Checks if the timing source synchronizes on pulse.
RealType	getFrequency () const noexcept
	Gets the frequency of the timing source.
RealType	getFreqOffset () const noexcept
	Gets the frequency offset of the timing source.
RealType	getPhaseOffset () const noexcept
	Gets the phase offset of the timing source.
bool	isEnabled () const noexcept
	Checks if the timing source is enabled.
void	skipSamples (std::size_t samples) noexcept
	Skips a number of samples in the timing model.
void	initializeModel (const PrototypeTiming *timing) noexcept
	Initializes the timing model.
void	reset () noexcept
	Resets the timing model.
std::unique_ptr< Timing >	clone () const
	Creates a new Timing instance based on the same prototype.

Detailed Description

Represents a timing source for simulation.

Definition at line 35 of file timing.h.

Constructor & Destructor Documentation

Timing() [1/3]

timing::Timing::Timing ( std::string  name, unsigned  seed, const SimId  id = 0  )

explicitnoexcept

Constructs a Timing object.

Parameters

name	The name of the timing source.
seed	The seed for the timing source's internal random number generator.

Definition at line 24 of file timing.cpp.

                                                                               :
        _name(std::move(name)), _id(id == 0 ? SimIdGenerator::instance().generateId(ObjectType::Timing) : id),
        _rng(seed), _seed(seed)
    {
    }

~Timing()

timing::Timing::~Timing ( )

default

Timing() [2/3]

timing::Timing::Timing ( const Timing &  )

delete

Timing() [3/3]

timing::Timing::Timing ( Timing &&  )

delete

Member Function Documentation

clone()

std::unique_ptr< Timing > timing::Timing::clone

(

)

const

Creates a new Timing instance based on the same prototype.

Returns

A unique_ptr to the new Timing object.

Exceptions

std::logic_error

if the timing object was not initialized from a prototype.

Definition at line 82 of file timing.cpp.

    {
        if (_prototype == nullptr)
        {
            LOG(Level::FATAL, "Cannot clone a Timing object that has not been initialized from a prototype.");
            throw std::logic_error("Cannot clone a Timing object that has not been initialized from a prototype.");
        }
        auto new_timing = std::make_unique<Timing>(_name, _seed, _id);
        new_timing->initializeModel(_prototype);
        return new_timing;
    }

References LOG, and max.

getFreqOffset()

RealType timing::Timing::getFreqOffset ( ) const

noexcept

Gets the frequency offset of the timing source.

Returns

The frequency offset.

Definition at line 103 of file timing.h.

{ return _freq_offset; }

getFrequency()

RealType timing::Timing::getFrequency ( ) const

noexcept

Gets the frequency of the timing source.

Returns

The frequency of the timing source.

Definition at line 97 of file timing.h.

{ return _frequency; }

getId()

SimId timing::Timing::getId ( ) const

noexcept

Gets the unique ID of the timing source.

Returns

The timing source SimId.

Definition at line 76 of file timing.h.

{ return _id; }

getName()

std::string timing::Timing::getName ( ) const

noexcept

Gets the name of the timing source.

Returns

The name of the timing source.

Definition at line 68 of file timing.h.

{ return _name; }

getNextSample()

RealType timing::Timing::getNextSample ( ) const

noexcept

Gets the next sample from the timing source.

Returns

The next sample value or 0.0 if not enabled.

Definition at line 61 of file timing.h.

{ return _enabled ? _model->getSample() : 0.0; }

getPhaseOffset()

RealType timing::Timing::getPhaseOffset ( ) const

noexcept

Gets the phase offset of the timing source.

Returns

The phase offset.

Definition at line 109 of file timing.h.

{ return _phase_offset; }

getSeed()

unsigned timing::Timing::getSeed ( ) const

noexcept

Gets the initial seed used for the timing source's RNG.

Returns

The initial seed value.

Definition at line 83 of file timing.h.

{ return _seed; }

getSyncOnPulse()

bool timing::Timing::getSyncOnPulse ( ) const

noexcept

Checks if the timing source synchronizes on pulse.

Returns

True if synchronized on pulse, otherwise false.

Definition at line 90 of file timing.h.

{ return _sync_on_pulse; }

initializeModel()

void timing::Timing::initializeModel ( const PrototypeTiming *  timing )

noexcept

Initializes the timing model.

Parameters

timing

The prototype timing configuration used for initialization.

Definition at line 39 of file timing.cpp.

    {
        if (_model)
        {
            LOG(Level::WARNING, "Timing source '{}' already initialized. Skipping re-initialization.", _name);
            return;
        }
 
        _prototype = timing;
        _frequency = timing->getFrequency();
 
        std::normal_distribution normal_dist{0.0, 1.0};
 
        _freq_offset = timing->getFreqOffset().value_or(0);
        if (const std::optional<RealType> random_freq_stdev = timing->getRandomFreqOffsetStdev(); random_freq_stdev)
        {
            LOG(Level::INFO, "Timing source '{}': applying random frequency offset with stdev {} Hz.", _name,
                random_freq_stdev.value());
            _freq_offset += normal_dist(_rng) * random_freq_stdev.value();
        }
 
        _phase_offset = timing->getPhaseOffset().value_or(0);
        if (const std::optional<RealType> random_phase_stdev = timing->getRandomPhaseOffsetStdev(); random_phase_stdev)
        {
            LOG(Level::INFO, "Timing source '{}': applying random phase offset with stdev {} radians.", _name,
                random_phase_stdev.value());
            _phase_offset += normal_dist(_rng) * random_phase_stdev.value();
        }
 
        timing->copyAlphas(_alphas, _weights);
 
        _model = std::make_unique<noise::ClockModelGenerator>(_rng, _alphas, _weights, _frequency, _phase_offset,
                                                              _freq_offset, 15);
 
        if (timing->getFrequency() == 0.0)
        {
            LOG(Level::INFO, "Timing source frequency not set, results could be incorrect.");
        }
 
        _sync_on_pulse = timing->getSyncOnPulse();
        _enabled = true;
    }

References LOG, and max.

isEnabled()

bool timing::Timing::isEnabled ( ) const

noexcept

Checks if the timing source is enabled.

Returns

True if enabled, otherwise false.

Definition at line 116 of file timing.h.

{ return _enabled && _model && _model->enabled(); }

operator=() [1/2]

Timing & timing::Timing::operator= ( const Timing &  )

delete

operator=() [2/2]

Timing & timing::Timing::operator= ( Timing &&  )

delete

reset()

void timing::Timing::reset ( )

noexcept

Resets the timing model.

Definition at line 136 of file timing.h.

        {
            if (_model)
            {
                _model->reset();
            }
        }

skipSamples()

void timing::Timing::skipSamples ( std::size_t  samples )

noexcept

Skips a number of samples in the timing model.

Parameters

samples

The number of samples to skip.

Definition at line 31 of file timing.cpp.

    {
        if (_enabled && _model)
        {
            _model->skipSamples(samples);
        }
    }

---

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

• packages/libfers/src/timing/timing.h
• packages/libfers/src/timing/timing.cpp