optris::CompositeAlarmStatus Class Reference

Encapsulates the status of the composite alarm. More...

#include <CompositeAlarmStatus.h>

Collaboration diagram for optris::CompositeAlarmStatus:

Public Member Functions
	CompositeAlarmStatus ()=default
	Constructor.
bool	isActive () const noexcept
	Returns whether the composite alarm is active.
const std::vector< AlarmChannelStatus > &	getActiveChannelStatuses () const noexcept
	Returns the statuses of the active alarm channels contributing to the composite alarm.
int	getActiveChannelCount () const noexcept
	Returns the count of active alarm channels contributing to the composite alarm.
void	reset () noexcept
	Resets the composite alarm status.
void	addChannelStatus (const AlarmChannelStatus &channel) noexcept
	Adds the status of an active alarm channel contributing to the composite alarm.

Detailed Description

Encapsulates the status of the composite alarm.

Member Function Documentation

addChannelStatus()

void optris::CompositeAlarmStatus::addChannelStatus ( const AlarmChannelStatus & channel )

inlinenoexcept

Adds the status of an active alarm channel contributing to the composite alarm.

Parameters

[in]

channel

status of an active alarm channel to add.

getActiveChannelCount()

int optris::CompositeAlarmStatus::getActiveChannelCount ( ) const

inlinenoexcept

Returns the count of active alarm channels contributing to the composite alarm.

Returns

count of active alarm channels contributing to the composite alarm. Zero, if the composite alarm is not active.

See also

AlarmChannelStatus::isActive()

getActiveChannelStatuses()

const std::vector< AlarmChannelStatus > & optris::CompositeAlarmStatus::getActiveChannelStatuses ( ) const

inlinenoexcept

Returns the statuses of the active alarm channels contributing to the composite alarm.

Returns

statuses of the active alarm channels contributing to the composite alarm. Empty, if the composite alarm is not active.

See also

AlarmChannelStatus::isActive()

isActive()

bool optris::CompositeAlarmStatus::isActive ( ) const

inlinenoexcept

Returns whether the composite alarm is active.

The composite alarm is considered active, if at least one of its alarm channels is active. If none of its alarm channels is active or if it does not have alarm channels, it will be inactive.

Returns

true if the composite alarm is active, false otherwise.

See also

AlarmChannelStatus::isActive()

---

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

• CompositeAlarmStatus.h