# Svc::AssertFatalAdapter Component

## 1. Introduction

`Svc::AssertFatalAdapter` is a passive component that intercepts calls to FW_ASSERT and issues FATAL events for each.

## 2. Requirements

The requirements for `Svc::AssertFatalAdapter` are as follows:

Requirement | Description | Verification Method
----------- | ----------- | -------------------
AF-001 | The `Svc::AssertFatalAdapter` component shall convert all calls to FW_ASSERT to FATAL events | Unit test

## 3. Design

### 3.1 Context

#### 3.1.1 Component Diagram

The `Svc::AssertFatalAdapter` component has the following component diagram:

![AssertFatalAdapter Diagram](img/AssertFatalAdapterBDD.jpg "AssertFatalAdapter")

#### 3.1.2 Ports

The `Svc::AssertFatalAdapter` component uses only the log infrastructure ports.

Port Data Type | Name | Direction | Kind | Usage
-------------- | ---- | --------- | ---- | -----
`Fw::Log` | Log | output | Output | Port for emitting events
`Fw::LogText` | LogText | output | Output | Port for emitting text events
`Fw::Time` | Time | output | Output | Port for getting the time

#### 3.2 Functional Description

The `Svc::AssertFatalAdapter` component contains a private implementation of the `Fw::AssertHook` base class (`AssertFatalAdapter`). Upon instantiation, the derived class registers itself to receive calls the FW_ASSERT. When it receives any one of them, it issues a FATAL event corresponding to the number of arguments to FW_ASSERT. Whatever mechanism in the system that deals with FATAL events will handle the asserts via that mechanism.    

### 3.3 Scenarios

#### 3.3.1 FW_ASSERT calls

When FW_ASSERT fires, the registered hook logs the assert message via `Fw::Logger` and then issues the
FATAL event (`AF_ASSERT_0` through `AF_ASSERT_6`) matching the number of assert arguments. If the `Log`
output port is not connected, or more than `FW_ASSERT_COUNT_MAX` asserts are already being processed
(a cascading-assert guard), the component falls back to the C `assert()` instead of issuing an event.


### 3.4 State

`Svc::AssertFatalAdapter` has no state machines.

### 3.5 Algorithms

`Svc::AssertFatalAdapter` has no significant algorithms.

## 4. Change Log

Date | Description
---- | -----------
10/16/2016 | Implementation and unit tests