Sierra Toolkit  Version of the Day
stk_classic::Throttle Struct Reference

Class Throttle describes the cutoff limits for a message throttle. More...

#include <RuntimeMessage.hpp>

Public Member Functions

 Throttle (size_t cutoff, int group)
 

Public Attributes

size_t m_cutoff
 Maximum number to display.
 
int m_group
 Throttle group of message.
 
size_t m_count
 Number which have been displayed.
 

Detailed Description

Class Throttle describes the cutoff limits for a message throttle.

Definition at line 84 of file RuntimeMessage.hpp.

Constructor & Destructor Documentation

◆ Throttle()

stk_classic::Throttle::Throttle ( size_t  cutoff,
int  group 
)
inline

Creates a new Throttle instance.

Parameters
cutoffa size_t value to display before the message is no longer displayed.
groupan int value to identify the throttle group that this message belongs to.

Definition at line 96 of file RuntimeMessage.hpp.


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