SmartSoft Component-Developer API
Public Member Functions | List of all members
Smart::PrescaleManager Class Reference

This helper class allows dividing an update frequency by a given factor. More...

#include <smartPrescaleManager.h>

Public Member Functions

 PrescaleManager (const unsigned int &prescaleFactor=1)
 default initialization constructor More...
 
PrescaleManageroperator= (const unsigned int &prescaleFactor)
 
bool isUpdateDue ()
 

Detailed Description

This helper class allows dividing an update frequency by a given factor.

Often data arrives at input ports at a certain periodic update frequency. Clients however often are not interested in all updates but in a subset of updates. The lower rate can be specified in the component model and this class helps in realizing this subdivided update frequency.

Constructor & Destructor Documentation

◆ PrescaleManager()

Smart::PrescaleManager::PrescaleManager ( const unsigned int &  prescaleFactor = 1)
inline

default initialization constructor

Parameters
prescaleFactordivides the update frequency by this value

Member Function Documentation

◆ isUpdateDue()

bool Smart::PrescaleManager::isUpdateDue ( )
inline

◆ operator=()

PrescaleManager& Smart::PrescaleManager::operator= ( const unsigned int &  prescaleFactor)
inline

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