optris::AlarmChannel Class Reference

Interface representing an alarm channel. More...

#include <AlarmChannel.h>

Collaboration diagram for optris::AlarmChannel:

Public Types
using	ConstShared = std::shared_ptr<const AlarmChannel>
	Shared pointer type for alarm channels.

Public Member Functions
	AlarmChannel ()=default
	Constructor.
	AlarmChannel (const AlarmChannel &)=delete
	No copy constructor.
AlarmChannel &	operator= (const AlarmChannel &)=delete
	No copy assignment.
	AlarmChannel (AlarmChannel &&)=delete
	No move constructor.
AlarmChannel &	operator= (AlarmChannel &&)=delete
	No move assignment.
virtual	~AlarmChannel ()=default
	Destructor.
virtual std::int32_t	getId () const noexcept=0
	Returns the unique ID identifying the alarm channel.
virtual const std::string &	getName () const noexcept=0
	Returns the name of the alarm channel.
virtual const AlarmChannelConfig &	getConfig () const noexcept=0
	Returns the configuration of the alarm channel.

Detailed Description

Interface representing an alarm channel.

Member Function Documentation

getConfig()

virtual const AlarmChannelConfig & optris::AlarmChannel::getConfig ( ) const

pure virtualnoexcept

Returns the configuration of the alarm channel.

Returns

configuration of the alarm channel.

getId()

virtual std::int32_t optris::AlarmChannel::getId ( ) const

pure virtualnoexcept

Returns the unique ID identifying the alarm channel.

Returns

unique ID identifying the alarm channel.

getName()

virtual const std::string & optris::AlarmChannel::getName ( ) const

pure virtualnoexcept

Returns the name of the alarm channel.

Returns

name of the alarm channel.

---

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

• AlarmChannel.h