- Main Page
- Modules
- Classes

- Search for |

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# INSTLIB::ARMED_COUNT Class Reference
[ALARM]

`#include <alarm.H>`

Inherited by INSTLIB::ALARM_BASE.

List of all members.

## Public Member Functions

| ARMED_COUNT (THREADID max_threads, THREADID tid)
INT64 | Count (THREADID tid=0) const
BOOL | CounterAdvance (THREADID tid, INT64 ninst=1)
BOOL | CounterAdvanceCheckNThreads (THREADID tid, UINT32 LowTid, UINT32 HighTid, INT64 ninst=1)
BOOL | Active () const
VOID | ActivateCommon ()
void | Set (INT64 orig_count, BOOL rearm, BOOL always_armed, THREADID tid)

## Protected Member Functions

BOOL | Armed (THREADID tid=0) const
VOID | SetArmed (THREADID tid=0)
VOID | SetCount (THREADID tid, INT64 count)
VOID | ResetCount (THREADID tid)
VOID | Disarm (THREADID tid=0)

## Protected Attributes

INT64 | _orig_count
INT64 * | _count
BOOL * | _armed
BOOL | _active
BOOL | _rearm
BOOL | _always_armed
THREADID | _maxThreads
THREADID | _tid
PIN_LOCK | _pin_lock

## Detailed Description

Base class for many of the alarms. Holds an array of counts, an array of "armed" and some other common state.

## Member Function Documentation

VOID INSTLIB::ARMED_COUNT::ActivateCommon | ( |  | ) | `[inline]`

| Set the alarm to be active.

BOOL INSTLIB::ARMED_COUNT::Active | ( |  | ) | const`[inline]`

Returns:
  True if the alarm is active

BOOL INSTLIB::ARMED_COUNT::Armed | ( | THREADID | tid = `0` | ) | const`[inline, protected]`

Returns:
  Armed value for this alarm

INT64 INSTLIB::ARMED_COUNT::Count | ( | THREADID | tid = `0` | ) | const`[inline]`

Returns:
  Remaining count for this alarm

BOOL INSTLIB::ARMED_COUNT::CounterAdvance | ( | THREADID | tid,
|  | INT64 | ninst = `1`
| ) | `[inline]`

| Advance the counter

Returns:
  True if the alarm fires and should call its handler

BOOL INSTLIB::ARMED_COUNT::CounterAdvanceCheckNThreads | ( | THREADID | tid,
|  | UINT32 | LowTid,
|  | UINT32 | HighTid,
|  | INT64 | ninst = `1`
| ) | `[inline]`

| Advance the counter and check whether the alarm should fire. If a TID range was specified, the alarm will fire only after all the threads in the range have advanced past the specified count.

Returns:
  True if the alarm fires and should call its handler.

VOID INSTLIB::ARMED_COUNT::Disarm | ( | THREADID | tid = `0` | ) | `[inline, protected]`

| Set the armed value.

void INSTLIB::ARMED_COUNT::Set | ( | INT64 | orig_count,
|  | BOOL | rearm,
|  | BOOL | always_armed,
|  | THREADID | tid
| ) | `[inline]`

| Set several common fields

VOID INSTLIB::ARMED_COUNT::SetArmed | ( | THREADID | tid = `0` | ) | `[inline, protected]`

| Set the armed value.

VOID INSTLIB::ARMED_COUNT::SetCount | ( | THREADID | tid,
|  | INT64 | count
| ) | `[inline, protected]`

| Set the count value.

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

- alarm.H