Data structure for alarm. More...

#include <AlarmTypes.h>

Data Fields
const AlarmBaseRefType	alarmBase
	Reference to counter used as alarm base. More...

const EventMaskType	event
	Event to set if type is ALARM_ACTION_EVENT. More...

enum alarmActionType_e	actionType
	Type of the alarm. More...

union {
const void * action
	Untyped value to be used during configuration. More...

const TaskType task
	Task to activate if type is ALARM_ACTION_TASK or to set event for if type is ALARM_ACTION_EVENT. More...

const pAlarmCallback callback
	Callback to execute if type is ALARM_ACTION_CALLBACK. More...

const CounterType counter
	Counter to increment if type is ALARM_ACTION_COUNTER. More...

}	action

bool	running
	Whether or not the alarm is currently running. More...

TickType	expiration
	Absolute expiration value. More...

TickType	cycle
	Relative value used for cyclic alarm (zero for oneshot alarm) More...

Detailed Description

Data structure for alarm.

Definition at line 64 of file AlarmTypes.h.

Field Documentation

◆ action [1/2]

const void* action

Untyped value to be used during configuration.

Definition at line 69 of file AlarmTypes.h.

◆ action [2/2]

union { ... } action

◆ actionType

enum alarmActionType_e actionType

Type of the alarm.

Definition at line 66 of file AlarmTypes.h.

◆ alarmBase

const AlarmBaseRefType alarmBase

Reference to counter used as alarm base.

Definition at line 65 of file AlarmTypes.h.

◆ callback

const pAlarmCallback callback

Callback to execute if type is ALARM_ACTION_CALLBACK.

Definition at line 72 of file AlarmTypes.h.

◆ counter

const CounterType counter

Counter to increment if type is ALARM_ACTION_COUNTER.

Definition at line 73 of file AlarmTypes.h.

◆ cycle

TickType cycle

Relative value used for cyclic alarm (zero for oneshot alarm)

Definition at line 78 of file AlarmTypes.h.

◆ event

const EventMaskType event

Event to set if type is ALARM_ACTION_EVENT.

Definition at line 66 of file AlarmTypes.h.

◆ expiration

TickType expiration

Absolute expiration value.

Will be compared against alarmBase->value

Definition at line 76 of file AlarmTypes.h.

◆ running

bool running

Whether or not the alarm is currently running.

Definition at line 75 of file AlarmTypes.h.

◆ task

const TaskType task

Task to activate if type is ALARM_ACTION_TASK or to set event for if type is ALARM_ACTION_EVENT.

Definition at line 70 of file AlarmTypes.h.

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

/github/workspace/AutosarOS/include/Types/AlarmTypes.h

Data Fields