Health API

HasHealthIF

class HasHealthIF

Subclassed by AbstractTemperatureSensor, ControllerBase, DeviceHandlerBase, Fuse, HealthDevice, PowerSensor, PowerSwitcherComponent, SubsystemBase

Public Functions

virtual ReturnValue_t setHealth(HealthState health) = 0

Set the Health State The parent will be informed, if the Health changes.

Parameters:

health

virtual HasHealthIF::HealthState getHealth() = 0

Get Health State.

Returns:

Health State of the object

Public Static Attributes

static const Event HEALTH_INFO = MAKE_EVENT(6, severity::INFO)

P1: New Health, P2: Old Health.

static const Event OVERWRITING_HEALTH = MAKE_EVENT(9, severity::LOW)

Assembly overwrites health information of children to keep satellite alive.

static const Event TRYING_RECOVERY = MAKE_EVENT(10, severity::MEDIUM)

Someone starts a recovery of a component (typically power-cycle). No parameters.

static const Event RECOVERY_STEP = MAKE_EVENT(11, severity::MEDIUM)

Recovery is ongoing. Comes twice during recovery. P1: 0 for the first, 1 for the second event. P2: 0

static const Event RECOVERY_DONE = MAKE_EVENT(12, severity::MEDIUM)

Recovery was completed. Not necessarily successful. No parameters.