iv::diamar::indicators::AbstractDiamarIndicator Class Reference

#include <AbstractDiamarIndicator.hpp>

Inheritance diagram for iv::diamar::indicators::AbstractDiamarIndicator:

Collaboration diagram for iv::diamar::indicators::AbstractDiamarIndicator:

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

Public Member Functions
virtual void	updateIndicator ()=0
virtual AbstractComponentGUI *	panel ()=0
virtual std::optional< std::string >	processIndicatorIcon ()=0
virtual bool	isVisible () const =0
virtual bool	displayPanelDynamic () const =0

Protected Member Functions
IIndicator::EDialogPosition	getPosition () const override
eIndicatorRepresentationType	representationType () const override
std::optional< std::string >	processIndicatorText () override
std::optional< iv::types::color >	processIndicatorTextColor () override
std::optional< iv::types::color >	processIndicatorBackground () override
bool	isClickable () const override

Member Enumeration Documentation

EDialogPosition

enum class IIndicator::EDialogPosition

stronginherited

Enumerator
RightDown
WithIcon

eIndicatorRepresentationType

enum class IIndicator::eIndicatorRepresentationType

stronginherited

Enumerator
IconLarge
IconWithBadge
IconWithText

Member Function Documentation

displayPanelDynamic()

virtual bool IIndicator::displayPanelDynamic ( ) const

nodiscardpure virtualinherited

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

getPosition()

IIndicator::EDialogPosition iv::diamar::indicators::AbstractDiamarIndicator::getPosition ( ) const

nodiscardoverrideprotectedvirtual

Implements IIndicator.

isClickable()

bool iv::diamar::indicators::AbstractDiamarIndicator::isClickable ( ) const

nodiscardoverrideprotectedvirtual

Implements IIndicator.

Reimplemented in CIndicatorDeadMan.

isVisible()

virtual bool IIndicator::isVisible ( ) const

nodiscardpure virtualinherited

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

panel()

virtual AbstractComponentGUI * IIndicator::panel ( )

pure virtualinherited

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

processIndicatorBackground()

std::optional< iv::types::color > iv::diamar::indicators::AbstractDiamarIndicator::processIndicatorBackground ( )

overrideprotectedvirtual

Implements IIndicator.

processIndicatorIcon()

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

pure virtualinherited

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()

std::optional< std::string > iv::diamar::indicators::AbstractDiamarIndicator::processIndicatorText ( )

overrideprotectedvirtual

Implements IIndicator.

Reimplemented in CIndicatorAlarmWatchCall, and CIndicatorWatchCall.

processIndicatorTextColor()

std::optional< iv::types::color > iv::diamar::indicators::AbstractDiamarIndicator::processIndicatorTextColor ( )

overrideprotectedvirtual

Implements IIndicator.

Reimplemented in CIndicatorAlarmWatchCall, and CIndicatorWatchCall.

representationType()

IIndicator::eIndicatorRepresentationType iv::diamar::indicators::AbstractDiamarIndicator::representationType ( ) const

nodiscardoverrideprotectedvirtual

Implements IIndicator.

Reimplemented in CIndicatorAlarmWatchCall, and CIndicatorWatchCall.

updateIndicator()

virtual void IIndicator::updateIndicator ( )

pure virtualinherited

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 files:

• src/diamar/indicators/AbstractDiamarIndicator.hpp
• src/diamar/indicators/AbstractDiamarIndicator.cpp