iv::mimics::elements::Fan Class Reference

#include <Fan.hpp>

Inheritance diagram for iv::mimics::elements::Fan:

Collaboration diagram for iv::mimics::elements::Fan:

Classes
struct	DefaultValues
struct	FanElementsColors
struct	Keys
struct	Sections

Public Types
enum class	eAuxiliaryFanRunState {   NoLinked , Stop , NoStop , NoRun ,   StopRunUndefined0 , Undefined , Run , RunFast }
enum class	eAuxiliaryFanDirection {   NoLinked , SupplyExhaustUndefined0 , Undefined , Supply ,   NoSupply , Exhaust , NoExhaust }

Public Member Functions
	Fan ()
	Fan (iv::mimics::eMimicElementType type)
	Fan (const Fan &other)
	~Fan () override=default
bool	load (const iv::file::xml::node &nodeControlMimic) override
bool	save (iv::file::xml::node &nodeControlMimic) const override
void	getChannels (const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &channelsInControl) const override
	Añade los canales que el MimicElement tiene enlazado.
void	mapChannels (const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> &mapFunction) override
	Processed gets ///.
void	executeCommand (const std::string &strAction) const override
	Run actions ///.
std::shared_ptr< iv::mimics::AbstractMimicElement >	clone () const override
std::optional< iv::types::color >	getColorWorkingState () const override
	Retrieves the color representing the current working state of the element.
std::optional< iv::types::color >	getColorControlState () const override
	Retrieves the color representing the current control state of the element.
std::optional< std::string >	getStringWorkingState () const override
std::optional< std::string >	getStringControlState () const override
std::optional< iv::mimics::eAlarmState >	getAlarmState () const override
void	drawSpecific (IGraphics *graphics, std::optional< iv::types::color > colorWorkingState, std::optional< iv::types::color > colorControlState, iv::eLanguage drawingLanguage) override
	Draws the specific abstract element shape.
AbstractComponentGUI *	panelEditControl () override
	UI methods ///.
void	addOptionsMenu (const std::shared_ptr< iv::mimics::MimicControlMenu > &menu) override
const iv::mimics::TitleSettings &	getTitleSettings () const
std::weak_ptr< iv::mimics::OnlineVariables >	getOnlineVariables () const
virtual void	updateEnabledLanguages (const std::set< iv::eLanguage > &enabledLanguages)
bool	isPointInMimic (iv::types::coord x, iv::types::coord y) const
virtual iv::math::geometry::Point2d	getAlarmIconPosition (const iv::math::geometry::Area &elementSize) const
virtual bool	canShowCircularMenu () const
	Behaviours gets ///.
virtual bool	hasAlternativeAction () const
virtual void	runCommandControlWithoutMenu ()
	Ejecuta un comando accionado sin el menu de opciones (caso de un botón)
virtual void	runAlternativeAction (CDialog *dlgFatherRef)
	Ejecuta código específico del control.
virtual void	runEvaluation ()
	Ejecuta la evaluación del control.
virtual void	postProcess ()
	PROCESSES.
void	draw (IGraphics *graphics, iv::eLanguage drawingLanguage, const std::optional< std::unordered_set< iv::types::channelId > > &channelsRepeatedOpt=std::nullopt, const std::optional< std::set< std::shared_ptr< AbstractMimicElement > > > &otherMimicElements=std::nullopt)
	DRAWS.
void	setRedrawFlag (bool reDrawFlag=true)
void	removeGraphicsObjects (IGraphics *graphics)
	Elimina el elemento gráfico.
virtual void	move (double dx, double dy)
	MOVEMENTS.
bool	rotate (double angle)
void	handleEvent (CEventMotion *evtMotion)

Public Attributes
eZDepth	m_depth
iv::mimics::eMimicElementType	m_mimicElementType
iv::mimics::Location	m_location
iv::types::width	m_width
iv::types::height	m_height
iv::mimics::TitleSettings	m_titleSettings
iv::mimics::Background	m_background
std::shared_ptr< OnlineVariables >	m_onlineVariables
std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > >	m_addedAlarms

Protected Member Functions
std::vector< iv::math::geometry::Point2d >	calculateLimits (IGraphics *graphics, iv::eLanguage drawingLanguage)
virtual bool	checkIntegrity () const
virtual bool	hasRepeatedChannels (const std::unordered_set< iv::types::channelId > &channelsRepeatedOpt) const
	Checks if the current mimic element contains any repeated channels.
virtual bool	isRepeatedMimicElement (const std::set< std::shared_ptr< AbstractMimicElement > > &otherMimicsElements) const
	Determines whether the current mimic element shares significant similarities with others.
AbstractComponentGUI *	buttonEditTitle ()
AbstractComponentGUI *	panelEditSize ()
AbstractComponentGUI *	panelEditOnlineVariables () const
AbstractComponentGUI *	panelEditAddedAlarms () const

Protected Attributes
bool	m_redrawFlag {false}

Private Member Functions
void	drawSimpleFan (IGraphics *graphics, const std::optional< iv::types::color > &colorWorkingState) const
void	drawSimpleWithFastFan (IGraphics *graphics, const std::optional< iv::types::color > &colorWorkingState, const std::optional< iv::types::color > &colorControlState, eFanRunState stateRun) const
void	drawReverseFan (IGraphics *graphics, const std::optional< iv::types::color > &colorWorkingState, eFanRunState stateRun, eFanDirection stateDirection) const
void	drawReverseWithFastFan (IGraphics *graphics, const std::optional< iv::types::color > &colorWorkingState, const std::optional< iv::types::color > &colorControlState, eFanRunState runState, eFanDirection directionState) const
void	drawBladedFan (IGraphics *graphics, const std::optional< iv::types::color > &colorWorkingState, const std::optional< iv::types::color > &colorControlState, eFanRunState stateRun, eFanDirection stateDirection) const
eFanRunState	calculateFanRunState () const
eFanDirection	calculateFanDirection () const
std::unique_ptr< CDrawText >	prvCreateTextTitle (iv::eLanguage language) const
void	applyPosition (IGraphics *graphics) const
void	applyRotation (IGraphics *graphics) const
std::optional< iv::mimics::eAlarmState >	getAddedAlarmsMimicAlarmState () const
bool	loadAutomaticSemiAuto (const iv::file::xml::node &nodeAutomatic)
bool	saveAutomaticSemiAuto (iv::file::xml::node &nodeAutomatic) const
void	getChannelsAutomaticSemiAuto (const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &channelsInControl) const
void	mapChannelsAutomaticSemiAuto (const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> &mapFunction)
eAutomaticState	getState () const
std::string_view	getIconState () const
AbstractComponentGUI *	panelEditAutomaticManual ()
void	addTraitOptionsMenu (const std::shared_ptr< iv::mimics::MimicControlMenu > &menu, const std::optional< std::function< bool(CDialog *)> > &autoCommandEvaluation, const std::optional< std::function< bool(CDialog *)> > &semiAutoCommandEvaluation) const
bool	loadControlLock (const iv::file::xml::node &nodeControlLock)
bool	saveControlLock (iv::file::xml::node &nodeControlLock) const
void	getChannelsControlLock (const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &channelsInControl) const
void	mapChannelsControlLock (const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> &mapFunction)
AbstractComponentGUI *	panelEditControlLock ()
bool	loadRemoteLocal (const iv::file::xml::node &nodeRemoteLocal)
bool	saveRemoteLocal (iv::file::xml::node &nodeRemoteLocal) const
void	getChannelsRemoteLocal (const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &channelsInControl) const
void	mapChannelsRemoteLocal (const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> &mapFunction)
eRemoteState	getState () const
std::string_view	getIconState () const
AbstractComponentGUI *	panelEditRemoteLocal ()
bool	loadTripReset (const iv::file::xml::node &nodeTripReset)
bool	saveTripReset (iv::file::xml::node &nodeTripReset) const
void	getChannelsTripReset (const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &channelsInControl) const
void	mapChannelsTripReset (const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> &mapFunction)
bool	isTrip () const
AbstractComponentGUI *	panelEditTrip ()
void	addTraitOptionsMenu (const std::shared_ptr< iv::mimics::MimicControlMenu > &menu, const std::optional< std::function< bool(CDialog *)> > &resetCommandEvaluation) const

Static Private Member Functions
static Fan::FanElementsColors	calculateArrowElementsColors (iv::types::color colorWorkingState, eFanRunState runState, eFanDirection directionState)
static void	runningStateBehaviorModel (const std::shared_ptr< iv::channels::AbstractChannel > &runFeedback, eAuxiliaryFanRunState &lastState, bool isFast)
static void	supplyDirectionBehaviorModel (const std::shared_ptr< iv::channels::AbstractChannel > &runFeedbackSupply, Fan::eAuxiliaryFanDirection &lastState)
static void	exhaustDirectionBehaviorModel (const std::shared_ptr< iv::channels::AbstractChannel > &runFeedbackExhaust, Fan::eAuxiliaryFanDirection &lastState)
static bool	checkHasRepeated (const std::unordered_set< iv::types::channelId > &repeatedChannels, const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > &elementChannels)

Private Attributes
iv::mimics::elements::eFanDesign	m_fanDesign
iv::mimics::elements::eFanType	m_fanType
iv::mimics::support::Maintenance	m_maintenance
iv::mimics::Channel	m_speedFeedback
iv::mimics::Channel	m_consignedSpeed
iv::mimics::Channel	m_userConsignedSpeed
iv::mimics::Channel	m_runFeedbackSupply
iv::mimics::Channel	m_runFeedbackSupplyFast
iv::mimics::Channel	m_runFeedbackExhaust
iv::mimics::Channel	m_runFeedbackExhaustFast
iv::mimics::Channel	m_stoppedFeedback
iv::mimics::Channel	m_startOrderSupply
iv::mimics::Channel	m_startOrderSupplyFast
iv::mimics::Channel	m_startOrderExhaust
iv::mimics::Channel	m_startOrderExhaustFast
iv::mimics::Channel	m_stopOrder
iv::mimics::Channel	m_startCommandSupply
iv::mimics::Channel	m_startCommandSupplyFast
iv::mimics::Channel	m_startCommandExhaust
iv::mimics::Channel	m_startCommandExhaustFast
iv::mimics::Channel	m_stopCommand
std::unique_ptr< CRectangleGraphics >	m_rectangleOpt {nullptr}
std::unique_ptr< CDrawText >	m_textTitleOpt
std::shared_ptr< std::vector< iv::math::geometry::Point2d > >	m_polylinesLimits
uint32_t	m_idBlockBackground
uint32_t	m_idBlockForegorund
bool	m_isCreatedForeground {false}
bool	m_isCreatedBackground {false}
bool	m_isMarked {false}
bool	m_withAutomatic
iv::mimics::Channel	m_automaticCommand
iv::mimics::Channel	m_semiAutoCommand
iv::mimics::Channel	m_automaticFeedback
bool	m_hasSemiAutoFeedback
iv::mimics::Channel	m_semiAutoFeedback
bool	m_hasControlLock
iv::mimics::Channel	m_controlLock
iv::mimics::Channel	m_remoteFeedback
bool	m_hasLocalFeedback
iv::mimics::Channel	m_localFeedback
iv::mimics::Channel	m_tripFeedback
bool	m_withCommandReset
iv::mimics::Channel	m_resetCommand
bool	m_hasResetConfirmation

Static Private Attributes
static constexpr double	kPrvRelationXY {0.7}

Member Enumeration Documentation

eAuxiliaryFanDirection

enum class iv::mimics::elements::Fan::eAuxiliaryFanDirection

strong

Enumerator
NoLinked
SupplyExhaustUndefined0
Undefined
Supply
NoSupply
Exhaust
NoExhaust

eAuxiliaryFanRunState

enum class iv::mimics::elements::Fan::eAuxiliaryFanRunState

strong

Enumerator
NoLinked
Stop
NoStop
NoRun
StopRunUndefined0
Undefined
Run
RunFast

Constructor & Destructor Documentation

Fan() [1/3]

iv::mimics::elements::Fan::Fan

(

)

Fan() [2/3]

iv::mimics::elements::Fan::Fan ( iv::mimics::eMimicElementType type )

explicit

Fan() [3/3]

iv::mimics::elements::Fan::Fan

(

const Fan &

other

)

~Fan()

iv::mimics::elements::Fan::~Fan ( )

overridedefault

Member Function Documentation

addOptionsMenu()

void iv::mimics::elements::Fan::addOptionsMenu ( const std::shared_ptr< iv::mimics::MimicControlMenu > & menu )

overridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

addTraitOptionsMenu() [1/2]

void iv::mimics::traits::AutomaticSemiAuto::addTraitOptionsMenu ( const std::shared_ptr< iv::mimics::MimicControlMenu > & menu, const std::optional< std::function< bool(CDialog *)> > & autoCommandEvaluation, const std::optional< std::function< bool(CDialog *)> > & semiAutoCommandEvaluation ) const

inherited

addTraitOptionsMenu() [2/2]

void iv::mimics::traits::TripReset::addTraitOptionsMenu ( const std::shared_ptr< iv::mimics::MimicControlMenu > & menu, const std::optional< std::function< bool(CDialog *)> > & resetCommandEvaluation ) const

inherited

applyPosition()

void iv::mimics::AbstractMimicElement::applyPosition ( IGraphics * graphics ) const

privateinherited

applyRotation()

void iv::mimics::AbstractMimicElement::applyRotation ( IGraphics * graphics ) const

privateinherited

buttonEditTitle()

AbstractComponentGUI * iv::mimics::AbstractMimicElement::buttonEditTitle ( )

protectedinherited

calculateArrowElementsColors()

Fan::FanElementsColors iv::mimics::elements::Fan::calculateArrowElementsColors ( iv::types::color colorWorkingState, eFanRunState runState, eFanDirection directionState )

staticprivate

calculateFanDirection()

eFanDirection iv::mimics::elements::Fan::calculateFanDirection ( ) const

nodiscardprivate

calculateFanRunState()

eFanRunState iv::mimics::elements::Fan::calculateFanRunState ( ) const

nodiscardprivate

calculateLimits()

std::vector< iv::math::geometry::Point2d > iv::mimics::AbstractMimicElement::calculateLimits ( IGraphics * graphics, iv::eLanguage drawingLanguage )

protectedinherited

canShowCircularMenu()

bool iv::mimics::AbstractMimicElement::canShowCircularMenu ( ) const

nodiscardvirtualinherited

Behaviours gets ///.

Reimplemented in iv::mimics::auxiliary::Link, iv::mimics::elements::PmsPriorities, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, iv::mimics::elementsPms::GeneratorPms, and iv::mimics::elementsPms::OperationModesPms.

checkHasRepeated()

bool iv::mimics::AbstractMimicElement::checkHasRepeated ( const std::unordered_set< iv::types::channelId > & repeatedChannels, const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & elementChannels )

staticprivateinherited

checkIntegrity()

bool iv::mimics::AbstractMimicElement::checkIntegrity ( ) const

nodiscardprotectedvirtualinherited

Reimplemented in iv::mimics::auxiliary::Image, iv::mimics::auxiliary::Line, iv::mimics::auxiliary::Link, iv::mimics::auxiliary::Polyline, iv::mimics::auxiliary::Text, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, iv::mimics::elementsPms::GeneratorPms, and iv::mimics::elementsPms::OperationModesPms.

clone()

std::shared_ptr< iv::mimics::AbstractMimicElement > iv::mimics::elements::Fan::clone ( ) const

nodiscardoverridevirtual

Implements iv::mimics::AbstractMimicElement.

draw()

void iv::mimics::AbstractMimicElement::draw ( IGraphics * graphics, iv::eLanguage drawingLanguage, const std::optional< std::unordered_set< iv::types::channelId > > & channelsRepeatedOpt = std::nullopt, const std::optional< std::set< std::shared_ptr< AbstractMimicElement > > > & otherMimicElements = std::nullopt )

inherited

DRAWS.

Dibuja el elemento en pantalla, con título, background, alarma, toda la parte común de todos los elementos.

Parameters

graphics
drawingLanguage	Language to draw the element
channelsRepeatedOpt

drawBladedFan()

void iv::mimics::elements::Fan::drawBladedFan ( IGraphics * graphics, const std::optional< iv::types::color > & colorWorkingState, const std::optional< iv::types::color > & colorControlState, eFanRunState stateRun, eFanDirection stateDirection ) const

private

drawReverseFan()

void iv::mimics::elements::Fan::drawReverseFan ( IGraphics * graphics, const std::optional< iv::types::color > & colorWorkingState, eFanRunState stateRun, eFanDirection stateDirection ) const

private

drawReverseWithFastFan()

void iv::mimics::elements::Fan::drawReverseWithFastFan ( IGraphics * graphics, const std::optional< iv::types::color > & colorWorkingState, const std::optional< iv::types::color > & colorControlState, eFanRunState runState, eFanDirection directionState ) const

private

drawSimpleFan()

void iv::mimics::elements::Fan::drawSimpleFan ( IGraphics * graphics, const std::optional< iv::types::color > & colorWorkingState ) const

private

drawSimpleWithFastFan()

void iv::mimics::elements::Fan::drawSimpleWithFastFan ( IGraphics * graphics, const std::optional< iv::types::color > & colorWorkingState, const std::optional< iv::types::color > & colorControlState, eFanRunState stateRun ) const

private

drawSpecific()

void iv::mimics::elements::Fan::drawSpecific ( IGraphics * graphics, std::optional< iv::types::color > colorWorkingState, std::optional< iv::types::color > colorControlState, iv::eLanguage drawingLanguage )

overridevirtual

Draws the specific abstract element shape.

Parameters

graphics
colorWorkingState
colorControlState
drawingLanguage

Implements iv::mimics::AbstractMimicElement.

executeCommand()

void iv::mimics::elements::Fan::executeCommand ( const std::string & strAction ) const

overridevirtual

Run actions ///.

Ejecuta un comando accionado desde el menu de opciones

Parameters

strAction

Implements iv::mimics::AbstractMimicElement.

exhaustDirectionBehaviorModel()

void iv::mimics::elements::Fan::exhaustDirectionBehaviorModel ( const std::shared_ptr< iv::channels::AbstractChannel > & runFeedbackExhaust, Fan::eAuxiliaryFanDirection & lastState )

staticprivate

getAddedAlarmsMimicAlarmState()

std::optional< iv::mimics::eAlarmState > iv::mimics::AbstractMimicElement::getAddedAlarmsMimicAlarmState ( ) const

nodiscardprivateinherited

getAlarmIconPosition()

iv::math::geometry::Point2d iv::mimics::AbstractMimicElement::getAlarmIconPosition ( const iv::math::geometry::Area & elementSize ) const

nodiscardvirtualinherited

Reimplemented in iv::mimics::elementsPms::GeneratorPms.

getAlarmState()

std::optional< iv::mimics::eAlarmState > iv::mimics::elements::Fan::getAlarmState ( ) const

nodiscardoverridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

getChannels()

void iv::mimics::elements::Fan::getChannels ( const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & channelsInControl ) const

overridevirtual

Añade los canales que el MimicElement tiene enlazado.

Parameters

[out]

channelsInControl

Map of channels in mimic element

Deprecated

This function may be substituted by mapChannels

Reimplemented from iv::mimics::AbstractMimicElement.

getChannelsAutomaticSemiAuto()

void iv::mimics::traits::AutomaticSemiAuto::getChannelsAutomaticSemiAuto ( const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & channelsInControl ) const

inherited

getChannelsControlLock()

void iv::mimics::traits::ControlLock::getChannelsControlLock ( const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & channelsInControl ) const

inherited

getChannelsRemoteLocal()

void iv::mimics::traits::RemoteLocal::getChannelsRemoteLocal ( const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & channelsInControl ) const

inherited

getChannelsTripReset()

void iv::mimics::traits::TripReset::getChannelsTripReset ( const std::shared_ptr< std::vector< std::weak_ptr< iv::channels::AbstractChannel > > > & channelsInControl ) const

inherited

getColorControlState()

std::optional< iv::types::color > iv::mimics::elements::Fan::getColorControlState ( ) const

nodiscardoverridevirtual

Retrieves the color representing the current control state of the element.

The control state describes how the element is being controlled, with examples including Remote/Local or Online/Offline. The returned color, if any, is intended to visually convey the control mode.

Returns

An optional color representing the control state. Returns std::nullopt the element has no control state.

Reimplemented from iv::mimics::AbstractMimicElement.

getColorWorkingState()

std::optional< iv::types::color > iv::mimics::elements::Fan::getColorWorkingState ( ) const

nodiscardoverridevirtual

Retrieves the color representing the current working state of the element.

The working state reflects the functional status of the element, which can represent states such as Running/Stopped, Open/Closed, or Undefined. The returned color, if any, is intended to visually indicate this status.

Returns

An optional color representing the working state. Returns std::nullopt if no color is the element has no working state.

Reimplemented from iv::mimics::AbstractMimicElement.

getIconState() [1/2]

std::string_view iv::mimics::traits::AutomaticSemiAuto::getIconState ( ) const

nodiscardinherited

getIconState() [2/2]

std::string_view iv::mimics::traits::RemoteLocal::getIconState ( ) const

nodiscardinherited

getOnlineVariables()

std::weak_ptr< iv::mimics::OnlineVariables > iv::mimics::AbstractMimicElement::getOnlineVariables ( ) const

nodiscardinherited

getState() [1/2]

eAutomaticState iv::mimics::traits::AutomaticSemiAuto::getState ( ) const

nodiscardinherited

getState() [2/2]

eRemoteState iv::mimics::traits::RemoteLocal::getState ( ) const

nodiscardinherited

getStringControlState()

std::optional< std::string > iv::mimics::elements::Fan::getStringControlState ( ) const

nodiscardoverridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

getStringWorkingState()

std::optional< std::string > iv::mimics::elements::Fan::getStringWorkingState ( ) const

nodiscardoverridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

getTitleSettings()

const iv::mimics::TitleSettings & iv::mimics::AbstractMimicElement::getTitleSettings ( ) const

inlinenodiscardinherited

handleEvent()

void iv::mimics::AbstractMimicElement::handleEvent ( CEventMotion * evtMotion )

inherited

TODO: No se usa, y junto a este, el executeCommand

hasAlternativeAction()

bool iv::mimics::AbstractMimicElement::hasAlternativeAction ( ) const

nodiscardvirtualinherited

Reimplemented in iv::mimics::auxiliary::Link, iv::mimics::elements::PmsPriorities, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, iv::mimics::elementsPms::GeneratorPms, and iv::mimics::elementsPms::OperationModesPms.

hasRepeatedChannels()

bool iv::mimics::AbstractMimicElement::hasRepeatedChannels ( const std::unordered_set< iv::types::channelId > & channelsRepeatedOpt ) const

protectedvirtualinherited

Checks if the current mimic element contains any repeated channels.

Parameters

channelsRepeatedOpt

A set of channel IDs that are considered as repeated.

Returns

True if at least one channel of the mimic element is found in channelsRepeatedOpt, false otherwise.

Reimplemented in iv::mimics::elements::DynamicText, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, and iv::mimics::elementsPms::GeneratorPms.

isPointInMimic()

bool iv::mimics::AbstractMimicElement::isPointInMimic ( iv::types::coord x, iv::types::coord y ) const

nodiscardinherited

isRepeatedMimicElement()

bool iv::mimics::AbstractMimicElement::isRepeatedMimicElement ( const std::set< std::shared_ptr< AbstractMimicElement > > & otherMimicsElements ) const

protectedvirtualinherited

Determines whether the current mimic element shares significant similarities with others.

Parameters

otherMimicsElements

A set of other mimics elements to be compared against.

Returns

True if the element is repeated, false otherwise.

Reimplemented in iv::mimics::elements::DynamicText, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, and iv::mimics::elementsPms::GeneratorPms.

isTrip()

bool iv::mimics::traits::TripReset::isTrip ( ) const

inherited

load()

bool iv::mimics::elements::Fan::load ( const iv::file::xml::node & nodeControlMimic )

overridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

loadAutomaticSemiAuto()

bool iv::mimics::traits::AutomaticSemiAuto::loadAutomaticSemiAuto ( const iv::file::xml::node & nodeAutomatic )

inherited

loadControlLock()

bool iv::mimics::traits::ControlLock::loadControlLock ( const iv::file::xml::node & nodeControlLock )

inherited

loadRemoteLocal()

bool iv::mimics::traits::RemoteLocal::loadRemoteLocal ( const iv::file::xml::node & nodeRemoteLocal )

inherited

loadTripReset()

bool iv::mimics::traits::TripReset::loadTripReset ( const iv::file::xml::node & nodeTripReset )

inherited

mapChannels()

void iv::mimics::elements::Fan::mapChannels ( const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> & mapFunction )

overridevirtual

Processed gets ///.

Applies a function over each channel in the mimic element

Parameters

mapFunction

Function to apply over each channel

Reimplemented from iv::mimics::AbstractMimicElement.

mapChannelsAutomaticSemiAuto()

void iv::mimics::traits::AutomaticSemiAuto::mapChannelsAutomaticSemiAuto ( const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> & mapFunction )

inherited

mapChannelsControlLock()

void iv::mimics::traits::ControlLock::mapChannelsControlLock ( const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> & mapFunction )

inherited

mapChannelsRemoteLocal()

void iv::mimics::traits::RemoteLocal::mapChannelsRemoteLocal ( const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> & mapFunction )

inherited

mapChannelsTripReset()

void iv::mimics::traits::TripReset::mapChannelsTripReset ( const std::function< void(std::weak_ptr< iv::channels::AbstractChannel > &)> & mapFunction )

inherited

move()

void iv::mimics::AbstractMimicElement::move ( double dx, double dy )

virtualinherited

MOVEMENTS.

Reimplemented in iv::mimics::auxiliary::Line, and iv::mimics::auxiliary::Polyline.

panelEditAddedAlarms()

AbstractComponentGUI * iv::mimics::AbstractMimicElement::panelEditAddedAlarms ( ) const

nodiscardprotectedinherited

panelEditAutomaticManual()

AbstractComponentGUI * iv::mimics::traits::AutomaticSemiAuto::panelEditAutomaticManual ( )

inherited

panelEditControl()

AbstractComponentGUI * iv::mimics::elements::Fan::panelEditControl ( )

overridevirtual

UI methods ///.

PANELS

Crea el panel de edición del control.

Returns

Panel de edición del control.

Implements iv::mimics::AbstractMimicElement.

panelEditControlLock()

AbstractComponentGUI * iv::mimics::traits::ControlLock::panelEditControlLock ( )

inherited

panelEditOnlineVariables()

AbstractComponentGUI * iv::mimics::AbstractMimicElement::panelEditOnlineVariables ( ) const

nodiscardprotectedinherited

panelEditRemoteLocal()

AbstractComponentGUI * iv::mimics::traits::RemoteLocal::panelEditRemoteLocal ( )

inherited

panelEditSize()

AbstractComponentGUI * iv::mimics::AbstractMimicElement::panelEditSize ( )

protectedinherited

panelEditTrip()

AbstractComponentGUI * iv::mimics::traits::TripReset::panelEditTrip ( )

inherited

postProcess()

void iv::mimics::AbstractMimicElement::postProcess ( )

virtualinherited

PROCESSES.

Procesa ciertos atributos del elemento.

Note

La intención es que se procese tras el panel de edición y que prepare el elemento para ser dibujado.

Reimplemented in iv::mimics::auxiliary::Line, and iv::mimics::auxiliary::Square.

prvCreateTextTitle()

std::unique_ptr< CDrawText > iv::mimics::AbstractMimicElement::prvCreateTextTitle ( iv::eLanguage language ) const

nodiscardprivateinherited

removeGraphicsObjects()

void iv::mimics::AbstractMimicElement::removeGraphicsObjects ( IGraphics * graphics )

inherited

Elimina el elemento gráfico.

Parameters

graphics

rotate()

bool iv::mimics::AbstractMimicElement::rotate ( double angle )

inherited

runAlternativeAction()

void iv::mimics::AbstractMimicElement::runAlternativeAction ( CDialog * dlgFatherRef )

virtualinherited

Ejecuta código específico del control.

Note

El objetivo es que este comportamiento sea específico de cada control y se ejecute al pulsar sobre el control si este no puede mostrar menú circular.

Reimplemented in iv::mimics::auxiliary::Link, iv::mimics::elements::PmsPriorities, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, iv::mimics::elementsPms::GeneratorPms, and iv::mimics::elementsPms::OperationModesPms.

runCommandControlWithoutMenu()

void iv::mimics::AbstractMimicElement::runCommandControlWithoutMenu ( )

virtualinherited

Ejecuta un comando accionado sin el menu de opciones (caso de un botón)

runEvaluation()

void iv::mimics::AbstractMimicElement::runEvaluation ( )

virtualinherited

Ejecuta la evaluación del control.

runningStateBehaviorModel()

void iv::mimics::elements::Fan::runningStateBehaviorModel ( const std::shared_ptr< iv::channels::AbstractChannel > & runFeedback, Fan::eAuxiliaryFanRunState & lastState, bool isFast )

staticprivate

save()

bool iv::mimics::elements::Fan::save ( iv::file::xml::node & nodeControlMimic ) const

overridevirtual

Reimplemented from iv::mimics::AbstractMimicElement.

saveAutomaticSemiAuto()

bool iv::mimics::traits::AutomaticSemiAuto::saveAutomaticSemiAuto ( iv::file::xml::node & nodeAutomatic ) const

inherited

saveControlLock()

bool iv::mimics::traits::ControlLock::saveControlLock ( iv::file::xml::node & nodeControlLock ) const

inherited

saveRemoteLocal()

bool iv::mimics::traits::RemoteLocal::saveRemoteLocal ( iv::file::xml::node & nodeRemoteLocal ) const

inherited

saveTripReset()

bool iv::mimics::traits::TripReset::saveTripReset ( iv::file::xml::node & nodeTripReset ) const

inherited

setRedrawFlag()

void iv::mimics::AbstractMimicElement::setRedrawFlag ( bool reDrawFlag = true )

inherited

supplyDirectionBehaviorModel()

void iv::mimics::elements::Fan::supplyDirectionBehaviorModel ( const std::shared_ptr< iv::channels::AbstractChannel > & runFeedbackSupply, Fan::eAuxiliaryFanDirection & lastState )

staticprivate

updateEnabledLanguages()

void iv::mimics::AbstractMimicElement::updateEnabledLanguages ( const std::set< iv::eLanguage > & enabledLanguages )

virtualinherited

Reimplemented in iv::mimics::auxiliary::Text, iv::mimics::elements::AlarmIndicator, iv::mimics::elements::Command, iv::mimics::elements::Digital, iv::mimics::elements::PmsPriorities, and iv::mimics::elementsPms::OperationModesPms.

Member Data Documentation

kPrvRelationXY

double iv::mimics::elements::Fan::kPrvRelationXY {0.7}

staticconstexprprivate

m_addedAlarms

std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel> > > iv::mimics::AbstractMimicElement::m_addedAlarms

inherited

m_automaticCommand

iv::mimics::Channel iv::mimics::traits::AutomaticSemiAuto::m_automaticCommand

inherited

m_automaticFeedback

iv::mimics::Channel iv::mimics::traits::AutomaticSemiAuto::m_automaticFeedback

inherited

m_background

iv::mimics::Background iv::mimics::AbstractMimicElement::m_background

inherited

m_consignedSpeed

iv::mimics::Channel iv::mimics::elements::Fan::m_consignedSpeed

private

m_controlLock

iv::mimics::Channel iv::mimics::traits::ControlLock::m_controlLock

inherited

m_depth

eZDepth iv::mimics::AbstractMimicElement::m_depth

inherited

Model

m_fanDesign

iv::mimics::elements::eFanDesign iv::mimics::elements::Fan::m_fanDesign

private

m_fanType

iv::mimics::elements::eFanType iv::mimics::elements::Fan::m_fanType

private

m_hasControlLock

bool iv::mimics::traits::ControlLock::m_hasControlLock

inherited

m_hasLocalFeedback

bool iv::mimics::traits::RemoteLocal::m_hasLocalFeedback

inherited

m_hasResetConfirmation

bool iv::mimics::traits::TripReset::m_hasResetConfirmation

inherited

m_hasSemiAutoFeedback

bool iv::mimics::traits::AutomaticSemiAuto::m_hasSemiAutoFeedback

inherited

m_height

iv::types::height iv::mimics::AbstractMimicElement::m_height

inherited

m_idBlockBackground

uint32_t iv::mimics::AbstractMimicElement::m_idBlockBackground

privateinherited

m_idBlockForegorund

uint32_t iv::mimics::AbstractMimicElement::m_idBlockForegorund

privateinherited

m_isCreatedBackground

bool iv::mimics::AbstractMimicElement::m_isCreatedBackground {false}

privateinherited

m_isCreatedForeground

bool iv::mimics::AbstractMimicElement::m_isCreatedForeground {false}

privateinherited

m_isMarked

bool iv::mimics::AbstractMimicElement::m_isMarked {false}

privateinherited

m_localFeedback

iv::mimics::Channel iv::mimics::traits::RemoteLocal::m_localFeedback

inherited

m_location

iv::mimics::Location iv::mimics::AbstractMimicElement::m_location

inherited

m_maintenance

iv::mimics::support::Maintenance iv::mimics::elements::Fan::m_maintenance

private

m_mimicElementType

iv::mimics::eMimicElementType iv::mimics::AbstractMimicElement::m_mimicElementType

inherited

m_onlineVariables

std::shared_ptr<OnlineVariables> iv::mimics::AbstractMimicElement::m_onlineVariables

inherited

m_polylinesLimits

std::shared_ptr<std::vector<iv::math::geometry::Point2d> > iv::mimics::AbstractMimicElement::m_polylinesLimits

privateinherited

m_rectangleOpt

std::unique_ptr<CRectangleGraphics> iv::mimics::elements::Fan::m_rectangleOpt {nullptr}

private

m_redrawFlag

bool iv::mimics::AbstractMimicElement::m_redrawFlag {false}

protectedinherited

Controller

m_remoteFeedback

iv::mimics::Channel iv::mimics::traits::RemoteLocal::m_remoteFeedback

inherited

m_resetCommand

iv::mimics::Channel iv::mimics::traits::TripReset::m_resetCommand

inherited

m_runFeedbackExhaust

iv::mimics::Channel iv::mimics::elements::Fan::m_runFeedbackExhaust

private

m_runFeedbackExhaustFast

iv::mimics::Channel iv::mimics::elements::Fan::m_runFeedbackExhaustFast

private

m_runFeedbackSupply

iv::mimics::Channel iv::mimics::elements::Fan::m_runFeedbackSupply

private

m_runFeedbackSupplyFast

iv::mimics::Channel iv::mimics::elements::Fan::m_runFeedbackSupplyFast

private

m_semiAutoCommand

iv::mimics::Channel iv::mimics::traits::AutomaticSemiAuto::m_semiAutoCommand

inherited

m_semiAutoFeedback

iv::mimics::Channel iv::mimics::traits::AutomaticSemiAuto::m_semiAutoFeedback

inherited

m_speedFeedback

iv::mimics::Channel iv::mimics::elements::Fan::m_speedFeedback

private

m_startCommandExhaust

iv::mimics::Channel iv::mimics::elements::Fan::m_startCommandExhaust

private

m_startCommandExhaustFast

iv::mimics::Channel iv::mimics::elements::Fan::m_startCommandExhaustFast

private

m_startCommandSupply

iv::mimics::Channel iv::mimics::elements::Fan::m_startCommandSupply

private

m_startCommandSupplyFast

iv::mimics::Channel iv::mimics::elements::Fan::m_startCommandSupplyFast

private

m_startOrderExhaust

iv::mimics::Channel iv::mimics::elements::Fan::m_startOrderExhaust

private

m_startOrderExhaustFast

iv::mimics::Channel iv::mimics::elements::Fan::m_startOrderExhaustFast

private

m_startOrderSupply

iv::mimics::Channel iv::mimics::elements::Fan::m_startOrderSupply

private

m_startOrderSupplyFast

iv::mimics::Channel iv::mimics::elements::Fan::m_startOrderSupplyFast

private

m_stopCommand

iv::mimics::Channel iv::mimics::elements::Fan::m_stopCommand

private

m_stopOrder

iv::mimics::Channel iv::mimics::elements::Fan::m_stopOrder

private

m_stoppedFeedback

iv::mimics::Channel iv::mimics::elements::Fan::m_stoppedFeedback

private

m_textTitleOpt

std::unique_ptr<CDrawText> iv::mimics::AbstractMimicElement::m_textTitleOpt

privateinherited

m_titleSettings

iv::mimics::TitleSettings iv::mimics::AbstractMimicElement::m_titleSettings

inherited

m_tripFeedback

iv::mimics::Channel iv::mimics::traits::TripReset::m_tripFeedback

inherited

m_userConsignedSpeed

iv::mimics::Channel iv::mimics::elements::Fan::m_userConsignedSpeed

private

m_width

iv::types::width iv::mimics::AbstractMimicElement::m_width

inherited

m_withAutomatic

bool iv::mimics::traits::AutomaticSemiAuto::m_withAutomatic

inherited

m_withCommandReset

bool iv::mimics::traits::TripReset::m_withCommandReset

inherited

---

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

• src/mimics/model/elements/Fan.hpp
• src/mimics/model/elements/Fan.cpp