iv::mimics::elements::Motor Class Reference

#include <Motor.hpp>

Inheritance diagram for iv::mimics::elements::Motor:

Collaboration diagram for iv::mimics::elements::Motor:

Classes
struct	DefaultValues
struct	Sections

Public Member Functions
	Motor ()
	~Motor () override=default
bool	load (const iv::file::xml::node &nodeControlMimic) override
bool	save (iv::file::xml::node &nodeControlMimic) const override
std::shared_ptr< iv::mimics::AbstractMimicElement >	clone () 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	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 ///.
iv::mimics::eDigitalState	getState () const
std::optional< iv::mimics::eAlarmState >	getAlarmState () const override
std::optional< bool >	isStateActive () const
std::optional< iv::types::color >	getColorWorkingState () const override
	Retrieves the color representing the current working state of the element.
std::optional< std::string >	getStringWorkingState () const override
const iv::mimics::TitleSettings &	getTitleSettings () const
std::weak_ptr< iv::mimics::OnlineVariables >	getOnlineVariables () const
virtual void	updateEnabledLanguages (const std::set< iv::eLanguage > &enabledLanguages)
virtual void	addOptionsMenu (const std::shared_ptr< iv::mimics::MimicControlMenu > &menu)
bool	isPointInMimic (iv::types::coord x, iv::types::coord y) const
virtual std::optional< iv::types::color >	getColorControlState () const
	Retrieves the color representing the current control state of the element.
virtual std::optional< std::string >	getStringControlState () 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
AbstractComponentGUI *	panelActivationMode ()
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
iv::mimics::Channel	m_closeFeedback
bool	m_withFeedbackOpen
iv::mimics::Channel	m_openFeedback
iv::mimics::elements::eActivationMode	m_activationMode
bool	m_activationValue
iv::mimics::support::Maintenance	m_maintenance
bool	m_redrawFlag {false}

Private Member Functions
	Motor (const Motor &other)
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

Static Private Member Functions
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
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}

Static Private Attributes
static constexpr double	kPrvRelationXY {4. / 3.}

Constructor & Destructor Documentation

Motor() [1/2]

iv::mimics::elements::Motor::Motor

(

)

~Motor()

iv::mimics::elements::Motor::~Motor ( )

overridedefault

Motor() [2/2]

iv::mimics::elements::Motor::Motor ( const Motor & other )

private

Member Function Documentation

addOptionsMenu()

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

virtualinherited

Reimplemented in iv::mimics::auxiliary::Image, iv::mimics::auxiliary::Text, iv::mimics::elements::Breaker, iv::mimics::elements::Command, iv::mimics::elements::Compressor, iv::mimics::elements::Damper, iv::mimics::elements::DynamicText, iv::mimics::elements::Fan, iv::mimics::elements::Generator, iv::mimics::elements::Pump, iv::mimics::elements::Tank, iv::mimics::elements::Text, iv::mimics::elements::Valve, iv::mimics::elementsAutomated::DamperAutomated, iv::mimics::elementsAutomated::ValveAutomated, iv::mimics::elementsPms::BreakerPms, and iv::mimics::elementsPms::GeneratorPms.

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

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::Motor::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

drawSpecific()

void iv::mimics::elements::Motor::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::Digital::executeCommand ( const std::string & strAction ) const

overridevirtualinherited

Run actions ///.

Ejecuta un comando accionado desde el menu de opciones

Parameters

strAction

Implements iv::mimics::AbstractMimicElement.

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::Digital::getAlarmState ( ) const

nodiscardoverridevirtualinherited

Reimplemented from iv::mimics::AbstractMimicElement.

getChannels()

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

overridevirtualinherited

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.

getColorControlState()

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

nodiscardvirtualinherited

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 in iv::mimics::elements::Compressor, iv::mimics::elements::Damper, iv::mimics::elements::Fan, iv::mimics::elements::Generator, and iv::mimics::elements::Pump.

getColorWorkingState()

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

nodiscardoverridevirtualinherited

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.

Reimplemented in iv::mimics::elements::Shaft.

getOnlineVariables()

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

nodiscardinherited

getState()

iv::mimics::eDigitalState iv::mimics::Digital::getState ( ) const

nodiscardinherited

getStringControlState()

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

nodiscardvirtualinherited

Reimplemented in iv::mimics::elements::Compressor, iv::mimics::elements::Damper, iv::mimics::elements::Fan, iv::mimics::elements::Generator, iv::mimics::elements::Pump, iv::mimics::elementsPms::BreakerPms, and iv::mimics::elementsPms::GeneratorPms.

getStringWorkingState()

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

nodiscardoverridevirtualinherited

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.

isStateActive()

std::optional< bool > iv::mimics::Digital::isStateActive ( ) const

nodiscardinherited

load()

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

overridevirtual

Reimplemented from iv::mimics::Digital.

mapChannels()

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

overridevirtualinherited

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.

move()

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

virtualinherited

MOVEMENTS.

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

panelActivationMode()

AbstractComponentGUI * iv::mimics::Digital::panelActivationMode ( )

protectedinherited

panelEditAddedAlarms()

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

nodiscardprotectedinherited

panelEditControl()

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

overridevirtual

UI methods ///.

PANELS

Crea el panel de edición del control.

Returns

Panel de edición del control.

Reimplemented from iv::mimics::Digital.

panelEditOnlineVariables()

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

nodiscardprotectedinherited

panelEditSize()

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

protectedinherited

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.

save()

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

overridevirtual

Reimplemented from iv::mimics::Digital.

setRedrawFlag()

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

inherited

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::Motor::kPrvRelationXY {4. / 3.}

staticconstexprprivate

m_activationMode

iv::mimics::elements::eActivationMode iv::mimics::Digital::m_activationMode

protectedinherited

m_activationValue

bool iv::mimics::Digital::m_activationValue

protectedinherited

m_addedAlarms

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

inherited

m_background

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

inherited

m_closeFeedback

iv::mimics::Channel iv::mimics::Digital::m_closeFeedback

protectedinherited

m_depth

eZDepth iv::mimics::AbstractMimicElement::m_depth

inherited

Model

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_location

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

inherited

m_maintenance

iv::mimics::support::Maintenance iv::mimics::Digital::m_maintenance

protectedinherited

m_mimicElementType

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

inherited

m_onlineVariables

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

inherited

m_openFeedback

iv::mimics::Channel iv::mimics::Digital::m_openFeedback

protectedinherited

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::Motor::m_rectangleOpt {nullptr}

private

m_redrawFlag

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

protectedinherited

Controller

m_textTitleOpt

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

privateinherited

m_titleSettings

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

inherited

m_width

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

inherited

m_withFeedbackOpen

bool iv::mimics::Digital::m_withFeedbackOpen

protectedinherited

---

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

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