optris::AlarmChannelStatus Class Reference

Encapsulates the status of an alarm channel. More...

#include <AlarmChannelStatus.h>

Collaboration diagram for optris::AlarmChannelStatus:

Public Member Functions
OTC_SDK_API	AlarmChannelStatus () noexcept
	Constructor.
std::int32_t	getId () const noexcept
	Returns the ID of the alarm channel.
const std::string &	getName () const noexcept
	Returns the name of the alarm channel.
AlarmState	getState () const noexcept
	Returns the state of the alarm channel.
bool	isActive () const noexcept
	Returns whether the alarm channel is active.
float	getValue () const noexcept
	Returns the value of the alarm channel on which the alarm state is based.
AlarmRangeRelation	getAlarmRangeRelation () const noexcept
	Returns the relation of the value to the alarm range.
OTC_SDK_API void	update (std::int32_t channelId, const std::string &name, AlarmState state, AlarmRangeRelation alarmRangeRelation, float value) noexcept
	Updates the status of the alarm channel.

Detailed Description

Encapsulates the status of an alarm channel.

Member Function Documentation

getAlarmRangeRelation()

AlarmRangeRelation optris::AlarmChannelStatus::getAlarmRangeRelation ( ) const

inlinenoexcept

Returns the relation of the value to the alarm range.

Returns

relation of the value to the alarm range.

getId()

std::int32_t optris::AlarmChannelStatus::getId ( ) const

inlinenoexcept

Returns the ID of the alarm channel.

Returns

alarm channel ID.

getName()

const std::string & optris::AlarmChannelStatus::getName ( ) const

inlinenoexcept

Returns the name of the alarm channel.

Returns

name of the alarm channel.

getState()

AlarmState optris::AlarmChannelStatus::getState ( ) const

inlinenoexcept

Returns the state of the alarm channel.

Returns

alarm channel state.

getValue()

float optris::AlarmChannelStatus::getValue ( ) const

inlinenoexcept

Returns the value of the alarm channel on which the alarm state is based.

Returns

value of the alarm channel on which the alarm state is based.

isActive()

bool optris::AlarmChannelStatus::isActive ( ) const

inlinenoexcept

Returns whether the alarm channel is active.

An alarm channel will be considered active, if its state is AlarmState::Active.

Returns

true if the alarm channel is active, false otherwise.

update()

OTC_SDK_API void optris::AlarmChannelStatus::update ( std::int32_t channelId, const std::string & name, AlarmState state, AlarmRangeRelation alarmRangeRelation, float value )

noexcept

Updates the status of the alarm channel.

Parameters

[in]	channelId	ID of the alarm channel.
[in]	name	name of the alarm channel.
[in]	state	state of the alarm channel.
[in]	alarmRangeRelation	the relation between the value and the alarm ranges.
[in]	value	value of the alarm channel on which the alarm state is based.

---

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

• AlarmChannelStatus.h