#include <AnalogChannel.hpp>

Inheritance diagram for iv::channels::AnalogChannel:

Collaboration diagram for iv::channels::AnalogChannel:

Classes
struct	DefaultValues

struct	Keys

struct	Sections

Public Member Functions
	~AnalogChannel () override=default

void	update (AbstractChannel &other) override

bool	load (const iv::file::xml::node &nodeChannel) override

bool	save (iv::file::xml::node &nodeChannel) const override

std::string	analogStrValue () const

std::string	getEngineeringUnitsStr () const override

iv::channels::AnalogAlarmLimits &	alarmLimits ()

iv::types::channelValue &	deadBand ()

iv::types::channelValue &	offset ()

iv::types::channelValue &	factor ()

uint8_t &	numberOfDecimals ()

iv::eMeasurementUnit &	measurementUnit ()

iv::channels::eAnalogSensorType &	analogSensorType ()

iv::types::channelValue &	sensorHigh ()

iv::types::channelValue &	sensorLow ()

std::string	formatValue () const override

iv::channels::FormattedValue	formattedValue () const override

virtual std::shared_ptr< AbstractChannel >	clone ()=0

void	deinitialize ()

virtual void	processAlarm (std::shared_ptr< iv::alarms::AlarmsManager > alarmManager)=0

virtual void	processValue ()=0

void	setValue (std::optional< iv::types::channelValue > value, const std::optional< iv::alarms::Alarm > &alarm, const std::optional< iv::types::networkId > &networkOrigin)

virtual void	calculateAlarm ()

template<typename T > requires std::is_same_v<T, bool> \|\| std::is_same_v<T, int32_t> \|\| std::is_same_v<T, uint32_t> \|\| std::is_same_v<T, float> \|\| std::is_same_v<T, uint64_t> \|\| std::is_same_v<T, double> \|\| std::is_same_v<T, std::string> \|\| std::is_same_v<T, const char *>
T	getValue () const

iv::types::channelValue	getRawData () const

virtual std::string	getRawDataUnit () const

const iv::types::channelId &	getChannelId () const

iv::types::channelOrder	getChannelOrder () const

const iv::channels::ChannelAlarmParameters &	getAlarmParameters () const

const std::map< iv::types::networkId, std::shared_ptr< iv::channels::INetworkInfo > > &	channelsNetwork () const

bool	isWired () const

bool	isVirtual () const

bool	isAnalog () const

bool	isDigital () const

bool	isString () const

bool	isSerialLine () const

bool	isAlarmCalculated () const

bool	hasValue () const

std::string	getAlarmIconName () const

iv::types::color	getColorStateRgb () const

iv::alarms::eAlarmPriority	getAlarmPriority () const

iv::alarms::eAlarmState	getAlarmState () const

iv::alarms::eAlarmType	getAlarmType () const
	TODO: Por defecto tal vez debería haber un undefined o algo así, pq en detalles del canal se dibuja — cd no es valido.

iv::channels::eInhibitionCondition	getInhibitionConditionState () const

std::weak_ptr< iv::units::Unit >	getUnit () const

Public Attributes
iv::types::channelId	m_tag

std::string	m_shipyardTag

iv::types::channelOrder	m_channelOrder

bool	m_isEnabled

std::weak_ptr< AbstractChannel >	m_inhibitionChannel

iv::channels::eChannelBaseType	m_baseType

iv::channels::eChannelSpecificType	m_specificType

iv::channels::eChannelArea	m_area

iv::channels::ChannelInfo	m_info

iv::channels::ChannelAlarmParameters	m_alarmParameters

iv::model::diamar::eVerificationStatus	m_verificationStatus

std::map< iv::types::networkId, std::shared_ptr< iv::channels::INetworkInfo > >	m_channelsNetwork

std::mutex	m_mutexUpdate

std::atomic< iv::channels::Value >	m_value

std::atomic< iv::alarms::Alarm >	m_alarm

std::optional< iv::types::networkId >	m_networkOrigin {}

std::optional< iv::types::stationId >	m_stationOrigin {}

std::atomic< iv::channels::Value >	m_lastReceivedValue

std::atomic< iv::alarms::Alarm >	m_lastReceivedAlarm

std::optional< iv::types::networkId >	m_lastNetworkOrigin {}

std::optional< iv::types::stationId >	m_lastStationOrigin {}

std::atomic< bool >	m_shouldCalculateAlarm

std::unique_ptr< iv::channels::controller::AbstractChannel >	m_controller

iv::types::unitId	m_idUnit

iv::types::indexChannel	m_indexChannel

iv::types::milliseconds	m_deinitTimeout {DefaultValues::deinitTimeout}

Protected Member Functions
	AnalogChannel ()

	AnalogChannel (const AnalogChannel &other)

bool	shouldStoreAlarm (iv::alarms::Alarm &alarm) const

virtual iv::types::channelValue	setRawData (iv::types::channelValue value)

Protected Attributes
iv::channels::AnalogAlarmLimits	m_alarmLimits

iv::types::channelValue	m_deadBand

iv::types::channelValue	m_offset

iv::types::channelValue	m_factor

uint8_t	m_numberOfDecimals

iv::eMeasurementUnit	m_measurementUnit

iv::channels::eAnalogSensorType	m_analogSensorType

iv::types::channelValue	m_sensorHigh

iv::types::channelValue	m_sensorLow

Friends
class	iv::channels::controller::AnalogChannel

Constructor & Destructor Documentation

◆ ~AnalogChannel()

iv::channels::AnalogChannel::~AnalogChannel ( )

overridedefault

◆ AnalogChannel() [1/2]

iv::channels::AnalogChannel::AnalogChannel ( )

protected

◆ AnalogChannel() [2/2]

iv::channels::AnalogChannel::AnalogChannel ( const AnalogChannel & other )

protected

Member Function Documentation

◆ alarmLimits()

iv::channels::AnalogAlarmLimits & iv::channels::AnalogChannel::alarmLimits ( )

◆ analogSensorType()

iv::channels::eAnalogSensorType & iv::channels::AnalogChannel::analogSensorType ( )

◆ analogStrValue()

std::string iv::channels::AnalogChannel::analogStrValue ( ) const

nodiscard

◆ calculateAlarm()

void iv::channels::AbstractChannel::calculateAlarm ( )

virtualinherited

Reimplemented in iv::channels::VirtualAnalog, iv::channels::VirtualDigital, and iv::channels::VirtualString.

◆ channelsNetwork()

const std::map< iv::types::networkId, std::shared_ptr< iv::channels::INetworkInfo > > & iv::channels::AbstractChannel::channelsNetwork ( ) const

nodiscardinherited

◆ clone()

virtual std::shared_ptr< AbstractChannel > iv::channels::AbstractChannel::clone ( )

pure virtualinherited

Implemented in iv::channels::VirtualAnalog, iv::channels::VirtualDigital, iv::channels::VirtualString, iv::channels::WiredAnalog, and iv::channels::WiredDigital.

◆ deadBand()

iv::types::channelValue & iv::channels::AnalogChannel::deadBand ( )

◆ deinitialize()

void iv::channels::AbstractChannel::deinitialize ( )

inherited

◆ factor()

iv::types::channelValue & iv::channels::AnalogChannel::factor ( )

◆ formattedValue()

iv::channels::FormattedValue iv::channels::AnalogChannel::formattedValue ( ) const

nodiscardoverridevirtual

Implements iv::channels::AbstractChannel.

◆ formatValue()

std::string iv::channels::AnalogChannel::formatValue ( ) const

nodiscardoverridevirtual

Implements iv::channels::AbstractChannel.

◆ getAlarmIconName()

std::string iv::channels::AbstractChannel::getAlarmIconName ( ) const

nodiscardinherited

◆ getAlarmParameters()

const iv::channels::ChannelAlarmParameters & iv::channels::AbstractChannel::getAlarmParameters ( ) const

nodiscardinherited

◆ getAlarmPriority()

iv::alarms::eAlarmPriority iv::channels::AbstractChannel::getAlarmPriority ( ) const

nodiscardinherited

◆ getAlarmState()

iv::alarms::eAlarmState iv::channels::AbstractChannel::getAlarmState ( ) const

nodiscardinherited

◆ getAlarmType()

iv::alarms::eAlarmType iv::channels::AbstractChannel::getAlarmType ( ) const

nodiscardinherited

TODO: Por defecto tal vez debería haber un undefined o algo así, pq en detalles del canal se dibuja — cd no es valido.

◆ getChannelId()

const iv::types::channelId & iv::channels::AbstractChannel::getChannelId ( ) const

nodiscardinherited

◆ getChannelOrder()

iv::types::channelOrder iv::channels::AbstractChannel::getChannelOrder ( ) const

nodiscardinherited

◆ getColorStateRgb()

iv::types::color iv::channels::AbstractChannel::getColorStateRgb ( ) const

nodiscardinherited

◆ getEngineeringUnitsStr()

std::string iv::channels::AnalogChannel::getEngineeringUnitsStr ( ) const

nodiscardoverridevirtual

Reimplemented from iv::channels::AbstractChannel.

◆ getInhibitionConditionState()

iv::channels::eInhibitionCondition iv::channels::AbstractChannel::getInhibitionConditionState ( ) const

nodiscardinherited

◆ getRawData()

iv::types::channelValue iv::channels::AbstractChannel::getRawData ( ) const

inherited

◆ getRawDataUnit()

std::string iv::channels::AbstractChannel::getRawDataUnit ( ) const

virtualinherited

Reimplemented in iv::channels::WiredAnalog.

◆ getUnit()

std::weak_ptr< iv::units::Unit > iv::channels::AbstractChannel::getUnit ( ) const

nodiscardinherited

◆ getValue()

template<typename T >
requires std::is_same_v<T, bool> || std::is_same_v<T, int32_t> || std::is_same_v<T, uint32_t> || std::is_same_v<T, float> || std::is_same_v<T, uint64_t> || std::is_same_v<T, double> || std::is_same_v<T, std::string> || std::is_same_v<T, const char *>

T iv::channels::AbstractChannel::getValue ( ) const

inherited

◆ hasValue()

bool iv::channels::AbstractChannel::hasValue ( ) const

nodiscardinherited

◆ isAlarmCalculated()

bool iv::channels::AbstractChannel::isAlarmCalculated ( ) const

inherited

◆ isAnalog()

bool iv::channels::AbstractChannel::isAnalog ( ) const

nodiscardinherited

◆ isDigital()

bool iv::channels::AbstractChannel::isDigital ( ) const

nodiscardinherited

◆ isSerialLine()

bool iv::channels::AbstractChannel::isSerialLine ( ) const

inherited

◆ isString()

bool iv::channels::AbstractChannel::isString ( ) const

nodiscardinherited

◆ isVirtual()

bool iv::channels::AbstractChannel::isVirtual ( ) const

nodiscardinherited

◆ isWired()

bool iv::channels::AbstractChannel::isWired ( ) const

nodiscardinherited

◆ load()

bool iv::channels::AnalogChannel::load ( const iv::file::xml::node & nodeChannel )

overridevirtual

Reimplemented from iv::channels::AbstractChannel.

Reimplemented in iv::channels::VirtualAnalog, and iv::channels::WiredAnalog.

◆ measurementUnit()

iv::eMeasurementUnit & iv::channels::AnalogChannel::measurementUnit ( )

◆ numberOfDecimals()

uint8_t & iv::channels::AnalogChannel::numberOfDecimals ( )

◆ offset()

iv::types::channelValue & iv::channels::AnalogChannel::offset ( )

◆ processAlarm()

virtual void iv::channels::AbstractChannel::processAlarm ( std::shared_ptr< iv::alarms::AlarmsManager > alarmManager )

pure virtualinherited

Implemented in iv::channels::VirtualAnalog, iv::channels::VirtualDigital, iv::channels::VirtualString, iv::channels::WiredAnalog, and iv::channels::WiredDigital.

◆ processValue()

virtual void iv::channels::AbstractChannel::processValue ( )

pure virtualinherited

Implemented in iv::channels::VirtualAnalog, iv::channels::VirtualDigital, iv::channels::VirtualString, iv::channels::WiredAnalog, and iv::channels::WiredDigital.

◆ save()

bool iv::channels::AnalogChannel::save ( iv::file::xml::node & nodeChannel ) const

overridevirtual

Reimplemented from iv::channels::AbstractChannel.

Reimplemented in iv::channels::VirtualAnalog, and iv::channels::WiredAnalog.

◆ sensorHigh()

iv::types::channelValue & iv::channels::AnalogChannel::sensorHigh ( )

◆ sensorLow()

iv::types::channelValue & iv::channels::AnalogChannel::sensorLow ( )

◆ setRawData()

iv::types::channelValue iv::channels::AbstractChannel::setRawData ( iv::types::channelValue value )

protectedvirtualinherited

Reimplemented in iv::channels::VirtualAnalog, and iv::channels::WiredAnalog.

◆ setValue()

void iv::channels::AbstractChannel::setValue	(	std::optional< iv::types::channelValue >	value,
		const std::optional< iv::alarms::Alarm > &	alarm,
		const std::optional< iv::types::networkId > &	networkOrigin )

inherited

◆ shouldStoreAlarm()

bool iv::channels::AbstractChannel::shouldStoreAlarm ( iv::alarms::Alarm & alarm ) const

protectedinherited

◆ update()

void iv::channels::AnalogChannel::update ( AbstractChannel & other )

overridevirtual

Reimplemented from iv::channels::AbstractChannel.

Reimplemented in iv::channels::VirtualAnalog, and iv::channels::WiredAnalog.

Friends And Related Symbol Documentation

◆ iv::channels::controller::AnalogChannel

friend class iv::channels::controller::AnalogChannel

friend

Member Data Documentation

◆ m_alarm

std::atomic<iv::alarms::Alarm> iv::channels::AbstractChannel::m_alarm

inherited

◆ m_alarmLimits

iv::channels::AnalogAlarmLimits iv::channels::AnalogChannel::m_alarmLimits

protected

◆ m_alarmParameters

iv::channels::ChannelAlarmParameters iv::channels::AbstractChannel::m_alarmParameters

inherited

◆ m_analogSensorType

iv::channels::eAnalogSensorType iv::channels::AnalogChannel::m_analogSensorType

protected

◆ m_area

iv::channels::eChannelArea iv::channels::AbstractChannel::m_area

inherited

◆ m_baseType

iv::channels::eChannelBaseType iv::channels::AbstractChannel::m_baseType

inherited

◆ m_channelOrder

iv::types::channelOrder iv::channels::AbstractChannel::m_channelOrder

inherited

◆ m_channelsNetwork

std::map<iv::types::networkId, std::shared_ptr<iv::channels::INetworkInfo> > iv::channels::AbstractChannel::m_channelsNetwork

inherited

◆ m_controller

std::unique_ptr<iv::channels::controller::AbstractChannel> iv::channels::AbstractChannel::m_controller

inherited

◆ m_deadBand

iv::types::channelValue iv::channels::AnalogChannel::m_deadBand

protected

◆ m_deinitTimeout

iv::types::milliseconds iv::channels::AbstractChannel::m_deinitTimeout {DefaultValues::deinitTimeout}

inherited

◆ m_factor

iv::types::channelValue iv::channels::AnalogChannel::m_factor

protected

◆ m_idUnit

iv::types::unitId iv::channels::AbstractChannel::m_idUnit

inherited

Info redundant for performance

◆ m_indexChannel

iv::types::indexChannel iv::channels::AbstractChannel::m_indexChannel

inherited

◆ m_info

iv::channels::ChannelInfo iv::channels::AbstractChannel::m_info

inherited

◆ m_inhibitionChannel

std::weak_ptr<AbstractChannel> iv::channels::AbstractChannel::m_inhibitionChannel

inherited

◆ m_isEnabled

bool iv::channels::AbstractChannel::m_isEnabled

inherited

◆ m_lastNetworkOrigin

std::optional<iv::types::networkId> iv::channels::AbstractChannel::m_lastNetworkOrigin {}

inherited

◆ m_lastReceivedAlarm

std::atomic<iv::alarms::Alarm> iv::channels::AbstractChannel::m_lastReceivedAlarm

inherited

◆ m_lastReceivedValue

std::atomic<iv::channels::Value> iv::channels::AbstractChannel::m_lastReceivedValue

inherited

◆ m_lastStationOrigin

std::optional<iv::types::stationId> iv::channels::AbstractChannel::m_lastStationOrigin {}

inherited

◆ m_measurementUnit

iv::eMeasurementUnit iv::channels::AnalogChannel::m_measurementUnit

protected

◆ m_mutexUpdate

std::mutex iv::channels::AbstractChannel::m_mutexUpdate

inherited

Controller

◆ m_networkOrigin

std::optional<iv::types::networkId> iv::channels::AbstractChannel::m_networkOrigin {}

inherited

◆ m_numberOfDecimals

uint8_t iv::channels::AnalogChannel::m_numberOfDecimals

protected

◆ m_offset

iv::types::channelValue iv::channels::AnalogChannel::m_offset

protected

◆ m_sensorHigh

iv::types::channelValue iv::channels::AnalogChannel::m_sensorHigh

protected

◆ m_sensorLow

iv::types::channelValue iv::channels::AnalogChannel::m_sensorLow

protected

◆ m_shipyardTag

std::string iv::channels::AbstractChannel::m_shipyardTag

inherited

◆ m_shouldCalculateAlarm

std::atomic<bool> iv::channels::AbstractChannel::m_shouldCalculateAlarm

inherited

◆ m_specificType

iv::channels::eChannelSpecificType iv::channels::AbstractChannel::m_specificType

inherited

◆ m_stationOrigin

std::optional<iv::types::stationId> iv::channels::AbstractChannel::m_stationOrigin {}

inherited

◆ m_tag

iv::types::channelId iv::channels::AbstractChannel::m_tag

inherited

◆ m_value

std::atomic<iv::channels::Value> iv::channels::AbstractChannel::m_value

inherited

◆ m_verificationStatus

iv::model::diamar::eVerificationStatus iv::channels::AbstractChannel::m_verificationStatus

inherited

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

src/channels/AnalogChannel.hpp
src/channels/AnalogChannel.cpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

◆ ~AnalogChannel()

◆ AnalogChannel() [1/2]

◆ AnalogChannel() [2/2]

Member Function Documentation

◆ alarmLimits()

◆ analogSensorType()

◆ analogStrValue()

◆ calculateAlarm()

◆ channelsNetwork()

◆ clone()

◆ deadBand()

◆ deinitialize()

◆ factor()

◆ formattedValue()

◆ formatValue()

◆ getAlarmIconName()

◆ getAlarmParameters()

◆ getAlarmPriority()

◆ getAlarmState()

◆ getAlarmType()

◆ getChannelId()

◆ getChannelOrder()

◆ getColorStateRgb()

◆ getEngineeringUnitsStr()

◆ getInhibitionConditionState()

◆ getRawData()

◆ getRawDataUnit()

◆ getUnit()

◆ getValue()

◆ hasValue()

◆ isAlarmCalculated()

◆ isAnalog()

◆ isDigital()

◆ isSerialLine()

◆ isString()

◆ isVirtual()

◆ isWired()

◆ load()

◆ measurementUnit()

◆ numberOfDecimals()

◆ offset()

◆ processAlarm()

◆ processValue()

◆ save()

◆ sensorHigh()

◆ sensorLow()

◆ setRawData()

◆ setValue()

◆ shouldStoreAlarm()

◆ update()

Friends And Related Symbol Documentation

◆ iv::channels::controller::AnalogChannel

Member Data Documentation

◆ m_alarm

◆ m_alarmLimits

◆ m_alarmParameters

◆ m_analogSensorType

◆ m_area

◆ m_baseType

◆ m_channelOrder

◆ m_channelsNetwork

◆ m_controller

◆ m_deadBand

◆ m_deinitTimeout

◆ m_factor

◆ m_idUnit

◆ m_indexChannel

◆ m_info

◆ m_inhibitionChannel

◆ m_isEnabled

◆ m_lastNetworkOrigin

◆ m_lastReceivedAlarm

◆ m_lastReceivedValue