IIndicator Class Reference

#include <IIndicator.hpp>

Inheritance diagram for IIndicator:

Public Types
enum class	EDialogPosition { RightDown , WithIcon }
enum class	eIndicatorRepresentationType { IconLarge , IconWithBadge , IconWithText }

Public Member Functions
	IIndicator ()=default
virtual	~IIndicator ()=default
virtual void	updateIndicator ()=0
virtual AbstractComponentGUI *	panel ()=0
virtual IIndicator::EDialogPosition	getPosition () const =0
virtual eIndicatorRepresentationType	representationType () const =0
virtual std::optional< std::string >	processIndicatorIcon ()=0
virtual std::optional< std::string >	processIndicatorText ()=0
virtual std::optional< iv::types::color >	processIndicatorTextColor ()=0
virtual std::optional< iv::types::color >	processIndicatorBackground ()=0
virtual bool	isVisible () const =0
virtual bool	isClickable () const =0
virtual bool	displayPanelDynamic () const =0

Member Enumeration Documentation

EDialogPosition

enum class IIndicator::EDialogPosition

strong

Enumerator
RightDown
WithIcon

eIndicatorRepresentationType

enum class IIndicator::eIndicatorRepresentationType

strong

Enumerator
IconLarge
IconWithBadge
IconWithText

Constructor & Destructor Documentation

IIndicator()

IIndicator::IIndicator ( )

default

~IIndicator()

virtual IIndicator::~IIndicator ( )

virtualdefault

Member Function Documentation

displayPanelDynamic()

virtual bool IIndicator::displayPanelDynamic ( ) const

nodiscardpure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorDeadMan, CIndicatorInhibition, CIndicatorInverted, CIndicatorOffScan, CIndicatorUser, CIndicatorWatchCall, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

getPosition()

virtual IIndicator::EDialogPosition IIndicator::getPosition ( ) const

nodiscardpure virtual

Implemented in iv::diamar::indicators::AbstractDiamarIndicator, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

isClickable()

virtual bool IIndicator::isClickable ( ) const

nodiscardpure virtual

Implemented in CIndicatorDeadMan, iv::diamar::indicators::AbstractDiamarIndicator, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

isVisible()

virtual bool IIndicator::isVisible ( ) const

nodiscardpure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorDeadMan, CIndicatorInhibition, CIndicatorInverted, CIndicatorOffScan, CIndicatorUser, CIndicatorWatchCall, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

panel()

virtual AbstractComponentGUI * IIndicator::panel ( )

pure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorDeadMan, CIndicatorInhibition, CIndicatorInverted, CIndicatorOffScan, CIndicatorUser, CIndicatorWatchCall, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

processIndicatorBackground()

virtual std::optional< iv::types::color > IIndicator::processIndicatorBackground ( )

pure virtual

Implemented in iv::diamar::indicators::AbstractDiamarIndicator, iv::diamar::indicators::diamarRepeater::IndicatorActiveAlarms, iv::diamar::indicators::diamarRepeater::IndicatorActiveWarnings, iv::diamar::indicators::diamarRepeater::IndicatorAlarmsAck, iv::diamar::indicators::diamarRepeater::IndicatorInhibiteds, iv::diamar::indicators::diamarRepeater::IndicatorReturnsNoAck, and iv::diamar::indicators::diamarRepeater::IndicatorWarningsAck.

processIndicatorIcon()

virtual std::optional< std::string > IIndicator::processIndicatorIcon ( )

pure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorDeadMan, CIndicatorInhibition, CIndicatorInverted, CIndicatorOffScan, CIndicatorUser, CIndicatorWatchCall, iv::diamar::indicators::diamarRepeater::IndicatorActiveAlarms, iv::diamar::indicators::diamarRepeater::IndicatorActiveWarnings, iv::diamar::indicators::diamarRepeater::IndicatorAlarmsAck, iv::diamar::indicators::diamarRepeater::IndicatorInhibiteds, iv::diamar::indicators::diamarRepeater::IndicatorReturnsNoAck, and iv::diamar::indicators::diamarRepeater::IndicatorWarningsAck.

processIndicatorText()

virtual std::optional< std::string > IIndicator::processIndicatorText ( )

pure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorWatchCall, iv::diamar::indicators::AbstractDiamarIndicator, iv::diamar::indicators::diamarRepeater::IndicatorActiveAlarms, iv::diamar::indicators::diamarRepeater::IndicatorActiveWarnings, iv::diamar::indicators::diamarRepeater::IndicatorAlarmsAck, iv::diamar::indicators::diamarRepeater::IndicatorInhibiteds, iv::diamar::indicators::diamarRepeater::IndicatorReturnsNoAck, and iv::diamar::indicators::diamarRepeater::IndicatorWarningsAck.

processIndicatorTextColor()

virtual std::optional< iv::types::color > IIndicator::processIndicatorTextColor ( )

pure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorWatchCall, iv::diamar::indicators::AbstractDiamarIndicator, iv::diamar::indicators::diamarRepeater::IndicatorActiveAlarms, iv::diamar::indicators::diamarRepeater::IndicatorActiveWarnings, iv::diamar::indicators::diamarRepeater::IndicatorAlarmsAck, iv::diamar::indicators::diamarRepeater::IndicatorInhibiteds, iv::diamar::indicators::diamarRepeater::IndicatorReturnsNoAck, and iv::diamar::indicators::diamarRepeater::IndicatorWarningsAck.

representationType()

virtual eIndicatorRepresentationType IIndicator::representationType ( ) const

nodiscardpure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorWatchCall, iv::diamar::indicators::AbstractDiamarIndicator, and iv::diamar::indicators::diamarRepeater::AbstractDiamarRepeaterIndicator.

updateIndicator()

virtual void IIndicator::updateIndicator ( )

pure virtual

Implemented in CIndicatorAlarmWatchCall, CIndicatorDeadMan, CIndicatorInhibition, CIndicatorInverted, CIndicatorOffScan, CIndicatorUser, CIndicatorWatchCall, iv::diamar::indicators::diamarRepeater::IndicatorActiveAlarms, iv::diamar::indicators::diamarRepeater::IndicatorActiveWarnings, iv::diamar::indicators::diamarRepeater::IndicatorAlarmsAck, iv::diamar::indicators::diamarRepeater::IndicatorInhibiteds, iv::diamar::indicators::diamarRepeater::IndicatorReturnsNoAck, and iv::diamar::indicators::diamarRepeater::IndicatorWarningsAck.

---

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

• src/ui/gui/IIndicator.hpp