#include <ConditionConfig.hpp>

Inheritance diagram for blink1_control::config::ConditionConfig:

Public Types
enum	Type { Type::ProcessMonitor, Type::Rollup }

Public Attributes
Type	type

std::string	name

std::vector< std::string >	patterns

Friends
std::ostream &	operator<< (std::ostream &os, blink1_control::config::ConditionConfig::Type &configType)

std::ostream &	operator<< (std::ostream &os, blink1_control::config::ConditionConfig &config)

Detailed Description

Configuration for conditions

A condition is basically just a situation that can trigger an LED pattern to play.

Currently 2 types: ConditionConfig::Type::ProcessMonitor and ConditionConfig::Type::Rollup. Each is individually documented

Member Enumeration Documentation

◆ Type

enum blink1_control::config::ConditionConfig::Type

strong

Represents the Type of a condition. The Type basically decides how to turn states in the system into patterns for the LED

Enumerator
ProcessMonitor	This condition will run a process periodically and check the return value of the process. Will trigger different patterns for a "pass" state vs a "fail" state. The pass and fail states also go to the Rollup type
Rollup	A Rollup of other types basically takes the component conditions and combines them. If they are all passed, then the Rollup is passed. If one is failed, then the Rollup is failed.

Friends And Related Function Documentation

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	os,
		blink1_control::config::ConditionConfig &	config
	)

friend

Output operator

Parameters

os	Output stream
config	Config to output

◆ operator<< [2/2]

std::ostream& operator<<	(	std::ostream &	os,
		blink1_control::config::ConditionConfig::Type &	configType
	)

friend

Output operator

Parameters

os	Output stream
configType	ConditionConfig::Type to output

Member Data Documentation

◆ name

std::string blink1_control::config::ConditionConfig::name

The name of this condition

◆ patterns

std::vector<std::string> blink1_control::config::ConditionConfig::patterns

The list of patterns that can get activated based on the state of the condition

◆ type

Type blink1_control::config::ConditionConfig::type

The Type of this condition

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

include/config/ConditionConfig.hpp

Public Types

Public Attributes

Friends