Abstract class for rotary machines power elements. More...

#include <Machines.h>

Inheritance diagram for Machines:

[legend]

Collaboration diagram for Machines:

[legend]

Public Types
enum	SyncMachineModel { SM_MODEL_1 = 0 , SM_MODEL_2 , SM_MODEL_3 , SM_MODEL_4 , SM_MODEL_5 }

Public Member Functions
virtual bool	AddParent (Element *parent, wxPoint2DDouble position, bool isOpening=false)
	Add a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted.

virtual bool	Contains (wxPoint2DDouble position) const
	Checks if the element contains a position.

virtual void	DrawDC (GUIColour guiColour, wxPoint2DDouble translation, double scale, wxGraphicsContext gc) const
	Draw the element using GDI+.

virtual void	DrawDC (GUIColour *guiColour, wxPoint2DDouble translation, double scale, wxDC &dc) const
	Draw the element using wxDC.

virtual bool	Intersects (wxRect2DDouble rect) const
	Check if the element's rect intersects other rect.

virtual void	Move (wxPoint2DDouble position)
	Move the element other position.

virtual void	AlignToGrid (double gridSize=20.0) override

virtual void	MoveNode (Element *element, wxPoint2DDouble position)
	Move a node. StartMove(wxPoint2DDouble position) before start moving.

virtual void	StartMove (wxPoint2DDouble position)
	Update the element attributes related to the movement.

virtual void	RotateNode (Element *parent, bool clockwise=true)
	Rotate a node.

virtual void	RemoveParent (Element *parent)
	Remove a parent.

virtual bool	NodeContains (wxPoint2DDouble position)
	Check if a node contains a point. If contains, set the attributes related to node movement.

virtual bool	SetNodeParent (Element *parent)
	Set a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated.

virtual void	UpdateNodes ()
	Update the nodes according to the parents. If a parent is removed, use this method.

virtual void	Rotate (bool clockwise=true)
	Rotate the element.

virtual void	DrawDCSymbol (wxGraphicsContext *gc) const

virtual void	DrawDCSymbol (wxDC &dc) const

virtual void	SetPowerFlowDirection (PowerFlowDirection pfDirection)
	Set the direction of the power flow.

virtual void	UpdateSwitchesPosition () override

virtual void	UpdatePowerFlowArrowsPosition () override

Public Member Functions inherited from PowerElement
	PowerElement ()
	Constructor.

virtual	~PowerElement ()
	Destructor.

virtual wxPoint2DDouble	GetSwitchPoint (Element *parent, wxPoint2DDouble parentPoint, wxPoint2DDouble secondPoint) const
	Get the correct switch position.

virtual bool	SwitchesContains (wxPoint2DDouble position) const
	Check if switch contains position.

virtual void	UpdateSwitches ()
	Update the switch position.

virtual void	DrawDCSwitches (GUIColour guiColour, wxGraphicsContext gc) const
	Draw switch.

virtual void	DrawDCSwitches (GUIColour *guiColour, wxDC &dc) const

virtual void	CalculatePowerFlowPts (std::vector< wxPoint2DDouble > edges)
	Calculate the points of the power flow arrows.

virtual void	DrawDCPowerFlowPts (GUIColour guiColour, wxGraphicsContext gc) const
	Draw power flow arrows.

virtual void	DrawDCPowerFlowPts (GUIColour *guiColour, wxDC &dc) const

virtual void	SetNominalVoltage (std::vector< double > nominalVoltage, std::vector< ElectricalUnit > nominalVoltageUnit)
	Set nominal voltage of the element.

virtual void	SetSwitchingData (SwitchingData data)
	Set the switching data of the element.

virtual SwitchingData	GetSwitchingData ()
	Returns the switching data of the element.

virtual PowerFlowDirection	GetPowerFlowDirection () const
	Return the direction of the power flow.

virtual bool	GetPlotData (ElementPlotData &plotData, PlotStudy study=PlotStudy::STABILITY)
	Fill the plot data.

virtual bool	HaveDynamicEvent () const
	Check if the power element have dynamic event.

virtual void	SetDynamicEvent (bool dynEvent=true)
	Set if the power element have dynamic event.

virtual double	GetValueFromUnit (double value, ElectricalUnit valueUnit) const

virtual void	SaveCADProperties (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementNode)

virtual void	SaveSwitchingData (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *electricalNode)

virtual bool	OpenElement (rapidxml::xml_node<> elementNode, std::vector< Element > parentList)

virtual bool	OpenCADProperties (rapidxml::xml_node<> elementNode, std::vector< Element > parentList)

virtual bool	OpenSwitchingData (rapidxml::xml_node<> *electricalNode)

Public Member Functions inherited from Element
	Element ()
	Constructor.

virtual	~Element ()
	Destructor.

void	SetDragging (bool dragging=true)
	Set if the element are being dragged.

void	SetHeight (double height)
	Set element height.

void	SetPosition (const wxPoint2DDouble position)
	Set the element position and update the rectangle.

void	SetSelected (bool selected=true)
	Set element selection.

void	SetWidth (double width)
	Set element width.

void	SetAngle (double angle)
	Set element angle.

void	ShowPickbox (bool showPickbox=true)
	Set if the pickbox is shown.

void	SetBorderSize (double borderSize)
	Set the size of the border (shown in selected elements).

bool	SetOnline (bool online=true)
	Set if the element is online or offline.

virtual void	SetPointList (std::vector< wxPoint2DDouble > pointList)
	Set the list of points that connect the element to the bus.

ElementType	GetElementType ()

wxRect2DDouble	GetRect () const
	Get the element rectangle.

wxPoint2DDouble	GetPosition () const
	Get the element position.

bool	IsDragging () const
	Checks if the element is being dragged.

double	GetHeight () const
	Get the element height.

bool	IsSelected () const
	Checks if the element is selected.

double	GetWidth () const
	Get the element width.

double	GetAngle () const
	Get the element angle.

double	GetRotationAngle () const
	Get the angle of rotation.

bool	IsPickboxShown () const
	Checks if the pickbox is shown.

bool	IsOnline () const
	Checks if the element is online or offline.

virtual std::vector< wxPoint2DDouble >	GetPointList () const
	Get the list of points that connect the element to bus.

virtual std::vector< wxPoint2DDouble > &	GetPointListRef ()

virtual void	AddParent (Element *parent)
	Add a parent to the element.

virtual Element *	GetCopy ()
	Get a the element copy.

virtual void	SetID (int id)
	Set the element ID.

virtual int	GetID () const
	Get the element ID.

virtual void	AddChild (Element *child)
	Add a child to the child list.

virtual void	RemoveChild (Element *child)
	Remove a child from the list.

virtual void	ReplaceChild (Element oldChild, Element newChild)
	Replace a child from the list.

virtual wxString	GetTipText () const
	Get the tip text.

virtual bool	GetContextMenu (wxMenu &menu)
	Get the element contex menu.

virtual void	AddPoint (wxPoint2DDouble point)
	Add point to the list of points that connect the element to the bus.

void	SetParent (Element *parent, int num)

void	SetChild (Element *child, int num)

virtual void	ReplaceParent (Element oldParent, Element newParent)
	Replace a parent.

virtual bool	PickboxContains (wxPoint2DDouble position)
	Check if a pickbox contains a point. If contains the attributes related to pickbox movement will be calculated.

virtual void	MovePickbox (wxPoint2DDouble position)
	Move the pickbox.

virtual wxCursor	GetBestPickboxCursor () const
	Get the best cursor to shown to the user when the mouse is above a pickbox.

virtual void	ResetPickboxes ()
	Remove the pickboxes.

virtual void	ResetNodes ()
	Remove the active nodes.

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert the element position to screen position.

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble position, wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert a generic position to screen position.

virtual bool	RotatedRectanglesIntersects (wxRect2DDouble rect1, wxRect2DDouble rect2, double angle1, double angle2) const
	Check if two roteted rectangles intersect.

virtual void	DrawDCRectangle (wxPoint2DDouble position, double width, double height, double angle, wxDC &dc) const
	Draw a circle.

virtual void	DrawDCRoundedRectRotated (wxDC &dc, const wxPoint2DDouble &center, double width, double height, double radius, double angleDeg, int arcSegments=8) const

virtual void	DrawDCCircle (wxPoint2DDouble position, double radius, int numSegments, wxGraphicsContext *gc) const
	Draw a circle using device context.

virtual void	DrawDCCircle (wxPoint2DDouble position, double radius, wxDC &dc) const

virtual void	DrawDCArc (wxPoint2DDouble position, double radius, double initAngle, double finalAngle, int numSegments, wxGraphicsContext *gc) const

virtual void	DrawDCArc (wxPoint2DDouble position, double radius, double initAngle, double finalAngle, wxDC &dc) const

virtual void	DrawDCTriangle (std::vector< wxPoint2DDouble > points, wxGraphicsContext *gc) const
	Draw rectangle.

virtual void	DrawDCTriangle (std::vector< wxPoint > points, wxDC &dc) const

virtual void	DrawStabilityEventGC (wxGraphicsContext gc, wxPoint2DDouble translation, double scale, GUIColour guiColour, bool rotateAnchor=false, wxPoint2DDouble iconPosition=wxPoint2DDouble(-1, -1)) const

virtual void	DrawDCPickbox (wxPoint2DDouble position, wxGraphicsContext *gc) const
	Draw a point.

virtual wxPoint2DDouble	RotateAtPosition (wxPoint2DDouble pointToRotate, double angle, bool degrees=true) const
	Rotate a point as element position being the origin.

virtual wxPoint2DDouble	RotateLocal (wxPoint2DDouble local, double angleDeg) const

virtual wxPoint	RotateAround (const wxPoint2DDouble &p, const wxPoint2DDouble &center, double angleDeg) const

virtual std::vector< Element * >	GetParentList () const
	Get the parent list.

virtual std::vector< Element * >	GetChildList () const
	Get the Child list.

virtual wxPoint2DDouble	GetMoveStartPosition () const

virtual wxPoint2DDouble	GetMovePosition () const

virtual void	CalculateBoundaries (wxPoint2DDouble &leftUp, wxPoint2DDouble &rightBottom) const
	Calculate the element boundaries.

virtual void	GeneralMenuItens (wxMenu &menu)
	Insert general itens to context menu.

virtual bool	ShowForm (wxWindow parent, Element element, wxWindow *workspace=nullptr)
	Show element data form.

virtual double	PointToLineDistance (wxPoint2DDouble point, int *segmentNumber=nullptr) const
	Calculate the distance between a line (formed by point list) and a point.

bool	IsInserted () const
	Check if the element is properly inserted in the workspace.

void	SetInserted (bool inserted=true)
	Set if the element is properly inserted in the workspace.

virtual rapidxml::xml_node *	SaveElement (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementListNode)

virtual bool	OpenElement (rapidxml::xml_node<> *elementNode)

void	SaveCADProperties (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementNode)

bool	OpenCADProperties (rapidxml::xml_node<> *elementNode)

Additional Inherited Members
Static Public Member Functions inherited from Element
static bool	DoubleFromString (wxWindow *parent, wxString strValue, double &value, wxString errorMsg)
	Get a double value from a string. Show a error message if the conversion fail.

static bool	IntFromString (wxWindow *parent, wxString strValue, int &value, wxString errorMsg)
	Convert a string to int. Show a error message if the conversion fail.

static wxString	StringFromDouble (double value, int minDecimal=1, int maxDecimals=13)
	Convert a double value to string.

Protected Attributes inherited from PowerElement
SwitchingData	m_swData

std::vector< std::vector< wxPoint2DDouble > >	m_powerFlowArrow

PowerFlowDirection	m_pfDirection = PowerFlowDirection::PF_NONE

wxColour	m_busColour

wxColour	m_onlineElementColour

wxColour	m_offlineElementColour

wxColour	m_closedSwitchColour

wxColour	m_openedSwitchColour

wxColour	m_powerFlowArrowColour

wxColour	m_dynamicEventColour

bool	m_dynEvent = false

Protected Attributes inherited from Element
ElementType	m_elementType = ElementType::TYPE_NONE

int	m_elementID = 0

std::vector< Element * >	m_parentList

std::vector< Element * >	m_childList

wxRect2DDouble	m_rect

wxPoint2DDouble	m_position

double	m_width = 0.0

double	m_height = 0.0

double	m_angle = 0.0

double	m_borderSize = 2.0

double	m_rotationAngle = 45.0

double	m_switchSize = 10.0

std::vector< wxRect2DDouble >	m_switchRect

bool	m_selected = false

bool	m_dragging = false

bool	m_showPickbox = false

bool	m_inserted = false

int	m_activePickboxID = ID_PB_NONE

int	m_activeNodeID = 0

std::vector< wxPoint2DDouble >	m_pointList

std::vector< wxPoint2DDouble >	m_movePts

wxPoint2DDouble	m_moveStartPt

wxPoint2DDouble	m_movePos

bool	m_online = true

Detailed Description

Abstract class for rotary machines power elements.

Author: Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br

Date: 06/10/2017

Definition at line 33 of file Machines.h.

Member Enumeration Documentation

◆ SyncMachineModel

enum Machines::SyncMachineModel

Definition at line 36 of file Machines.h.

36{ SM_MODEL_1 = 0, SM_MODEL_2, SM_MODEL_3, SM_MODEL_4, SM_MODEL_5 };

Constructor & Destructor Documentation

◆ Machines()

Machines::Machines ( )

Definition at line 23 of file Machines.cpp.

23: PowerElement() {}

PowerElement::PowerElement

PowerElement()

Constructor.

Definition PowerElement.cpp:24

◆ ~Machines()

virtual Machines::~Machines ( )

inlinevirtual

Definition at line 39 of file Machines.h.

39{}

Member Function Documentation

◆ AddParent()

bool Machines::AddParent	(	Element *	parent,
		wxPoint2DDouble	position,
		bool	isOpening = `false`
	)

virtual

Add a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted.

Parameters

parent	Element parent.
position	Node position in the parent.

Reimplemented from Element.

Definition at line 24 of file Machines.cpp.

{
    if (parent) {
        m_parentList.push_back(parent);
        parent->AddChild(this);
 
        wxPoint2DDouble parentPt = parent->RotateAtPosition(position, -parent->GetAngle()); // Rotate click to horizontal position.
 
        parentPt.m_y = parent->GetPosition().m_y; // Centralize on bus.
        parentPt.m_x = std::round(parentPt.m_x / 20.0) * 20.0;   // Snap along bus to grid.
 
        double halfLength = parent->GetWidth() / 2.0;
        double minX = parent->GetPosition().m_x - halfLength;
        double maxX = parent->GetPosition().m_x + halfLength;
 
        if (parentPt.m_x < minX)
            parentPt.m_x = minX;
 
        if (parentPt.m_x > maxX)
            parentPt.m_x = maxX;
 
        parentPt = parent->RotateAtPosition(parentPt, parent->GetAngle()); // Rotate back.
 
        if (!isOpening) {
            // --------------------------------------------------------
            // Normal insertion:
            // determine machine position and orientation from the bus.
            // --------------------------------------------------------
 
            bool busHorizontal = (std::abs(parent->GetAngle() - 0.0) < 1.0 || std::abs(parent->GetAngle() - 180.0) < 1.0);
 
            if (busHorizontal) {
                if (position.m_y < parent->GetPosition().m_y) {
                    // Above bus: lead points down (+Y, angle 90).
                    m_position = parentPt + wxPoint2DDouble(0.0, -80.0);
                    m_angle = 90.0;
                }
                else {
                    // Below bus: lead points up (-Y, angle 270).
                    m_position = parentPt + wxPoint2DDouble(0.0, 80.0);
                    m_angle = 270.0;
                }
            }
            else {
                if (position.m_x < parent->GetPosition().m_x) {
                    // Left of bus: lead points right (+X, angle 0).
                    m_position = parentPt + wxPoint2DDouble(-80.0, 0.0);
                    m_angle = 0.0;
                }
                else {
                    // Right of bus: lead points left (-X, angle 180).
                    m_position = parentPt + wxPoint2DDouble(80.0, 0.0);
                    m_angle = 180.0;
                }
            }
        }
 
        // The following geometry is common to normal insertion and file loading.
        // When opening a file, m_position and m_angle are preserved from the file.
        m_width = m_height = 50.0;
        m_rect = wxRect2DDouble(m_position.m_x - 25.0, m_position.m_y - 25.0, m_width, m_height);
 
        SetPosition(m_position);
 
        // First point: connection point on the bus.
        m_pointList.push_back(parentPt);
 
        // Machine terminals are rigidly attached to the machine body.
        wxPoint2DDouble term1 = m_position + RotateLocal(wxPoint2DDouble(40.0, 0.0), m_angle);
        wxPoint2DDouble term2 = m_position + RotateLocal(wxPoint2DDouble(20.0, 0.0), m_angle);
 
        term1.m_x = std::round(term1.m_x);
        term1.m_y = std::round(term1.m_y);
 
        term2.m_x = std::round(term2.m_x);
        term2.m_y = std::round(term2.m_y);
 
        // Switch point.
        m_pointList.push_back(GetSwitchPoint(parent, parentPt, term1));
 
        // Machine terminals.
        m_pointList.push_back(term1);
        m_pointList.push_back(term2);
 
        m_inserted = true;
 
        wxRect2DDouble genRect(0, 0, 0, 0);
        m_switchRect.push_back(genRect);
 
        UpdateSwitches();
        UpdatePowerFlowArrowsPosition();
 
        return true;
    }
 
    return false;
}

Here is the call graph for this function:

◆ AlignToGrid()

void Machines::AlignToGrid ( double gridSize = 20.0 )

overridevirtual

Reimplemented from Element.

Definition at line 400 of file Machines.cpp.

{
    if (gridSize <= 0.0)
        gridSize = 20.0;
 
    // ------------------------------------------------------------
    // 1. Align m_position to the grid.
    // ------------------------------------------------------------
    wxPoint2DDouble oldPosition = m_position;
 
    wxPoint2DDouble newPosition(
        std::round(oldPosition.m_x / gridSize) * gridSize,
        std::round(oldPosition.m_y / gridSize) * gridSize);
 
    wxPoint2DDouble delta = newPosition - oldPosition;
 
    m_position = newPosition;
 
    //m_width = m_height = 50.0;
    //m_rect = wxRect2DDouble(m_position.m_x - 25.0, m_position.m_y - 25.0, m_width, m_height);
 
    SetPosition(m_position);
 
    // ------------------------------------------------------------
    // 2. Move the machine geometry together with m_position.
    //
    // Point 0 = bus connection.
    // Point 1 = switch.
    // Point 2+ = machine geometry.
    //
    // Point 0 is intentionally not moved here because it will
    // be aligned with the bus in the next step.
    // ------------------------------------------------------------
    for (size_t i = 2; i < m_pointList.size(); ++i) {
        m_pointList[i] += delta;
    }
 
    // ------------------------------------------------------------
    // 3. Recalculate the machine terminals rigidly attached to
    //    the machine body.
    // ------------------------------------------------------------
    if (m_pointList.size() >= 4) {
        wxPoint2DDouble t1 =
            m_position +
            RotateLocal(
                wxPoint2DDouble(40.0, 0.0),
                m_angle);
 
        wxPoint2DDouble t2 =
            m_position +
            RotateLocal(
                wxPoint2DDouble(20.0, 0.0),
                m_angle);
 
        m_pointList[2] = wxPoint2DDouble(
            std::round(t1.m_x),
            std::round(t1.m_y));
 
        m_pointList[3] = wxPoint2DDouble(
            std::round(t2.m_x),
            std::round(t2.m_y));
    }
 
    // ------------------------------------------------------------
    // 4. Align the bus connection point (m_pointList[0]) with
    //    m_pointList[2].
    //
    // The alignment does not depend on m_angle.
    // m_pointList[2] defines where the connection node should be
    // positioned along the bus.
    // ------------------------------------------------------------
    if (!m_parentList.empty() &&
        m_parentList[0] &&
        m_pointList.size() >= 3) {
 
        Element* bus = m_parentList[0];
 
        wxPoint2DDouble p2 = m_pointList[2];
 
        // Transform p2 into the local coordinate system of the bus.
        wxPoint2DDouble p2Delta(
            p2.m_x - bus->GetPosition().m_x,
            p2.m_y - bus->GetPosition().m_y);
 
        wxPoint2DDouble p2Local =
            bus->RotateLocal(
                p2Delta,
                -bus->GetAngle());
 
        // The connection point must:
        //   - have the same longitudinal coordinate as p2;
        //   - lie on the center line of the bus.
        wxPoint2DDouble candidateLocal(
            p2Local.m_x,
            0.0);
 
        // Check that the position is still within the bus.
        double halfWidth =
            bus->GetWidth() / 2.0 + 2.0;
 
        if (std::abs(candidateLocal.m_x) <= halfWidth) {
 
            // Transform the candidate back to global coordinates.
            wxPoint2DDouble candidate =
                bus->GetPosition() +
                bus->RotateLocal(
                    candidateLocal,
                    bus->GetAngle());
 
            m_pointList[0] = candidate;
        }
    }
    else if (!m_pointList.empty()) {
 
        // No parent: simply snap the connection point to the grid.
        m_pointList[0].m_x =
            std::round(
                m_pointList[0].m_x / gridSize) * gridSize;
 
        m_pointList[0].m_y =
            std::round(
                m_pointList[0].m_y / gridSize) * gridSize;
    }
 
    // ------------------------------------------------------------
    // 5. Update dependent geometry.
    // ------------------------------------------------------------
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ Contains()

virtual bool Machines::Contains ( wxPoint2DDouble position ) const

inlinevirtual

Checks if the element contains a position.

Parameters

position Position to be checked.

Implements Element.

Definition at line 42 of file Machines.h.

42{ return m_rect.Contains(position); }

◆ DrawDC() [1/2]

void Machines::DrawDC	(	GUIColour *	guiColour,
		wxPoint2DDouble	translation,
		double	scale,
		wxDC &	dc
	)		const

virtual

Draw the element using wxDC.

Parameters

guiColour	Colours of the system defined in properties.
translation	Translation of the system.
scale	Scale of the system.
dc	Device context.

Reimplemented from Element.

Definition at line 180 of file Machines.cpp.

{
    wxColour elementColour;
    if (m_online) {
        if (m_dynEvent)
            elementColour = guiColour->eventElement;
        else
            elementColour = guiColour->enabled;
    }
    else
        elementColour = guiColour->disable;
 
    std::vector<wxPoint> pointListInt;
    for (auto& pt : m_pointList) {
        pointListInt.emplace_back(static_cast<int>(pt.m_x), static_cast<int>(pt.m_y));
    }
 
    if (m_inserted) {
        // Draw Selection (layer 1).
        if (m_selected) {
            dc.SetPen(wxPen(guiColour->selection, 2 + m_borderSize * 2.0));
            dc.SetBrush(*wxTRANSPARENT_BRUSH);
            dc.DrawLines(pointListInt.size(), &pointListInt[0]);
 
            dc.SetPen(*wxTRANSPARENT_PEN);
            dc.SetBrush(wxBrush(guiColour->selection));
            DrawDCCircle(m_position, 20.0 + (m_borderSize + 1.5) / scale, dc);
 
            // Draw nodes selection.
            DrawDCCircle(m_pointList[0], 5.0 + m_borderSize / scale, dc);
        }
 
        // Draw Machines (layer 2).
        // Draw node.
        dc.SetPen(*wxTRANSPARENT_PEN);
        dc.SetBrush(wxBrush(elementColour));
        DrawDCCircle(m_pointList[0], 5.0, dc);
 
        dc.SetPen(wxPen(wxColour(elementColour), 2));
        dc.SetBrush(*wxTRANSPARENT_BRUSH);
        dc.DrawLines(pointListInt.size(), &pointListInt[0]);
        DrawDCCircle(m_position, 20.0, dc);
 
        DrawDCSwitches(guiColour, dc);
        DrawDCPowerFlowPts(guiColour, dc);
 
        dc.SetPen(*wxTRANSPARENT_PEN);
        dc.SetBrush(wxBrush(guiColour->background));
        DrawDCCircle(m_position, 20.0, dc);
 
        dc.SetPen(wxPen(elementColour, 2));
        dc.SetBrush(*wxTRANSPARENT_BRUSH);
        DrawDCCircle(m_position, 20.0, dc);
 
        // Draw machine symbol.
        DrawDCSymbol(dc);
    }
}

Here is the call graph for this function:

◆ DrawDC() [2/2]

void Machines::DrawDC	(	GUIColour *	guiColour,
		wxPoint2DDouble	translation,
		double	scale,
		wxGraphicsContext *	gc
	)		const

virtual

Draw the element using GDI+.

Parameters

guiColour	Colours of the system defined in properties.
translation	Translation of the system.
scale	Scale of the system.
gc	Graphics context

Reimplemented from Element.

Definition at line 122 of file Machines.cpp.

{
    wxColour elementColour;
    if (m_online) {
        //if (m_dynEvent)
        //  elementColour = guiColour->eventElement;
        //else
        elementColour = guiColour->enabled;
    }
    else
        elementColour = guiColour->disable;
 
    if (m_inserted) {
        // Draw Selection (layer 1).
        if (m_selected) {
            gc->SetPen(wxPen(guiColour->selection, 2 + m_borderSize * 2.0));
            gc->SetBrush(*wxTRANSPARENT_BRUSH);
            gc->StrokeLines(m_pointList.size(), &m_pointList[0]);
 
            gc->SetPen(*wxTRANSPARENT_PEN);
            gc->SetBrush(wxBrush(guiColour->selection));
            DrawDCCircle(m_position, 25.0 + (m_borderSize + 1.5) / scale, 20, gc);
 
            // Draw nodes selection.
            DrawDCCircle(m_pointList[0], 5.0 + m_borderSize / scale, 10, gc);
        }
 
        // Draw Machines (layer 2).
        // Draw node.
        gc->SetPen(*wxTRANSPARENT_PEN);
        gc->SetBrush(wxBrush(elementColour));
        DrawDCCircle(m_pointList[0], 5.0, 10, gc);
 
        gc->SetPen(wxPen(wxColour(elementColour), 2));
        gc->SetBrush(*wxTRANSPARENT_BRUSH);
        gc->StrokeLines(m_pointList.size(), &m_pointList[0]);
        DrawDCCircle(m_position, 25.0, 20.0, gc);
 
        DrawDCSwitches(guiColour, gc);
        DrawDCPowerFlowPts(guiColour, gc);
 
        gc->SetPen(*wxTRANSPARENT_PEN);
        gc->SetBrush(wxBrush(guiColour->background));
        DrawDCCircle(m_position, 25.0, 20.0, gc);
 
        gc->SetPen(wxPen(elementColour, 2));
        gc->SetBrush(*wxTRANSPARENT_BRUSH);
        DrawDCCircle(m_position, 25.0, 20.0, gc);
 
        // Draw machine symbol.
        DrawDCSymbol(gc);
 
        if (m_dynEvent) {
            DrawStabilityEventGC(gc, translation, scale, guiColour);
        }
    }
}

Here is the call graph for this function:

◆ DrawDCSymbol() [1/2]

virtual void Machines::DrawDCSymbol ( wxDC & dc ) const

inlinevirtual

Definition at line 59 of file Machines.h.

59{}

◆ DrawDCSymbol() [2/2]

virtual void Machines::DrawDCSymbol ( wxGraphicsContext * gc ) const

inlinevirtual

Definition at line 58 of file Machines.h.

58{}

◆ Intersects()

virtual bool Machines::Intersects ( wxRect2DDouble rect ) const

inlinevirtual

Check if the element's rect intersects other rect.

Parameters

rect	Rect to check intersection.

Implements Element.

Definition at line 46 of file Machines.h.

46{ return m_rect.Intersects(rect); }

Here is the caller graph for this function:

◆ Move()

void Machines::Move ( wxPoint2DDouble position )

virtual

Move the element other position.

Parameters

position Position that the element will be moved. Use StartMove(wxPoint2DDouble position) before start moving.

Reimplemented from Element.

Definition at line 250 of file Machines.cpp.

{
    SetPosition(m_movePos + position - m_moveStartPt);
    if (m_pointList.size() >= 4) {
        wxPoint2DDouble t1 = m_position + RotateLocal(wxPoint2DDouble(40.0, 0.0), m_angle);
        wxPoint2DDouble t2 = m_position + RotateLocal(wxPoint2DDouble(20.0, 0.0), m_angle);
        m_pointList[2] = wxPoint2DDouble(std::round(t1.m_x), std::round(t1.m_y));
        m_pointList[3] = wxPoint2DDouble(std::round(t2.m_x), std::round(t2.m_y));
    }
    if (!m_parentList[0]) {
        m_pointList[0] = m_movePts[0] + position - m_moveStartPt;
    }
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

Here is the call graph for this function:

◆ MoveNode()

void Machines::MoveNode	(	Element *	parent,
		wxPoint2DDouble	position
	)

virtual

Move a node. StartMove(wxPoint2DDouble position) before start moving.

Parameters

parent	Node's parent.
position	New node position.

Reimplemented from Element.

Definition at line 266 of file Machines.cpp.

{
    if (element) {
        if (element == m_parentList[0]) {
            m_pointList[0] = m_movePts[0] + position - m_moveStartPt;
        }
    }
    else {
        if (m_activeNodeID == 1) {
            m_pointList[0] = m_movePts[0] + position - m_moveStartPt;
            if (m_parentList[0]) {
                m_parentList[0]->RemoveChild(this);
                m_parentList[0] = nullptr;
                m_online = false;
            }
        }
    }
 
    // Recalculate switches positions
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ NodeContains()

bool Machines::NodeContains ( wxPoint2DDouble position )

virtual

Check if a node contains a point. If contains, set the attributes related to node movement.

Parameters

position Position tested.

Returns: True if at least one node contains the position, false otherwise.

Reimplemented from Element.

Definition at line 318 of file Machines.cpp.

{
    wxRect2DDouble nodeRect(m_pointList[0].m_x - 5.0 - m_borderSize, m_pointList[0].m_y - 5.0 - m_borderSize,
        10 + 2.0 * m_borderSize, 10 + 2.0 * m_borderSize);
 
    if (nodeRect.Contains(position)) {
        m_activeNodeID = 1;
        return true;
    }
 
    m_activeNodeID = 0;
    return false;
}

◆ RemoveParent()

void Machines::RemoveParent ( Element * parent )

virtual

Remove a parent.

Parameters

parent Parent to be removed.

Reimplemented from Element.

Definition at line 308 of file Machines.cpp.

{
    if (parent == m_parentList[0]) {
        m_parentList[0] = nullptr;
        m_online = false;
        UpdateSwitchesPosition();
        UpdatePowerFlowArrowsPosition();
    }
}

◆ Rotate()

void Machines::Rotate ( bool clockwise = true )

virtual

Rotate the element.

Parameters

clockwise True to rotate clockwise, false to rotate counter-clockwise.

Reimplemented from Element.

Definition at line 376 of file Machines.cpp.

{
    double rotAngle = m_rotationAngle;
    if (!clockwise) rotAngle = -m_rotationAngle;
 
    m_angle += rotAngle;
    while (m_angle >= 360.0) m_angle -= 360.0;
    while (m_angle < 0.0) m_angle += 360.0;
 
    if (std::abs(m_angle - 90.0) < 1e-4) m_angle = 90.0;
    else if (std::abs(m_angle - 180.0) < 1e-4) m_angle = 180.0;
    else if (std::abs(m_angle - 270.0) < 1e-4) m_angle = 270.0;
    else if (std::abs(m_angle - 0.0) < 1e-4 || std::abs(m_angle - 360.0) < 1e-4) m_angle = 0.0;
 
    if (m_pointList.size() >= 4) {
        wxPoint2DDouble t1 = m_position + RotateLocal(wxPoint2DDouble(40.0, 0.0), m_angle);
        wxPoint2DDouble t2 = m_position + RotateLocal(wxPoint2DDouble(20.0, 0.0), m_angle);
        m_pointList[2] = wxPoint2DDouble(std::round(t1.m_x), std::round(t1.m_y));
        m_pointList[3] = wxPoint2DDouble(std::round(t2.m_x), std::round(t2.m_y));
    }
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ RotateNode()

void Machines::RotateNode	(	Element *	parent,
		bool	clockwise = `true`
	)

virtual

Rotate a node.

Parameters

parent	Node's parent.
clockwise	True to rotate clockwise, false to rotate counter-clockwise.

Reimplemented from Element.

Definition at line 296 of file Machines.cpp.

{
    double rotAngle = m_rotationAngle;
    if (!clockwise) rotAngle = -m_rotationAngle;
 
    if (parent == m_parentList[0]) {
        m_pointList[0] = parent->RotateAtPosition(m_pointList[0], rotAngle);
        UpdateSwitchesPosition();
        UpdatePowerFlowArrowsPosition();
    }
}

Here is the call graph for this function:

◆ SetNodeParent()

bool Machines::SetNodeParent ( Element * parent )

virtual

Set a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated.

Parameters

parent Node parent.

Returns: True if was possible to set the parent.

Reimplemented from Element.

Definition at line 332 of file Machines.cpp.

{
    if (parent && m_activeNodeID != 0) {
        wxRect2DDouble nodeRect(m_pointList[0].m_x - 5.0 - m_borderSize, m_pointList[0].m_y - 5.0 - m_borderSize,
            10 + 2.0 * m_borderSize, 10 + 2.0 * m_borderSize);
 
        if (parent->Intersects(nodeRect)) {
            m_parentList[0] = parent;
 
            // Centralize the node on bus.
            wxPoint2DDouble parentPt =
                parent->RotateAtPosition(m_pointList[0], -parent->GetAngle());  // Rotate click to horizontal position.
            parentPt.m_y = parent->GetPosition().m_y;                           // Centralize on bus.
            parentPt = parent->RotateAtPosition(parentPt, parent->GetAngle());
            m_pointList[0] = parentPt;
 
            UpdateSwitchesPosition();
            UpdatePowerFlowArrowsPosition();
            return true;
        }
        else {
            m_parentList[0] = nullptr;
            m_online = false;
        }
    }
    return false;
}

Here is the call graph for this function:

◆ SetPowerFlowDirection()

void Machines::SetPowerFlowDirection ( PowerFlowDirection pfDirection )

virtual

Set the direction of the power flow.

Parameters

pfDirection Power flow direction.

Reimplemented from PowerElement.

Definition at line 553 of file Machines.cpp.

{
    m_pfDirection = pfDirection;
    UpdatePowerFlowArrowsPosition();
}

Here is the caller graph for this function:

◆ StartMove()

void Machines::StartMove ( wxPoint2DDouble position )

virtual

Update the element attributes related to the movement.

Parameters

position Start move position.

Reimplemented from Element.

Definition at line 289 of file Machines.cpp.

{
    m_moveStartPt = position;
    m_movePts = m_pointList;
    m_movePos = m_position;
}

◆ UpdateNodes()

void Machines::UpdateNodes ( )

virtual

Update the nodes according to the parents. If a parent is removed, use this method.

Reimplemented from Element.

Definition at line 360 of file Machines.cpp.

{
    if (m_parentList[0]) {
        wxRect2DDouble nodeRect(m_pointList[0].m_x - 5.0 - m_borderSize, m_pointList[0].m_y - 5.0 - m_borderSize,
            10 + 2.0 * m_borderSize, 10 + 2.0 * m_borderSize);
 
        if (!m_parentList[0]->Intersects(nodeRect)) {
            m_parentList[0]->RemoveChild(this);
            m_parentList[0] = nullptr;
            m_online = false;
            UpdateSwitchesPosition();
            UpdatePowerFlowArrowsPosition();
        }
    }
}

Here is the call graph for this function:

◆ UpdatePowerFlowArrowsPosition()

void Machines::UpdatePowerFlowArrowsPosition ( )

overridevirtual

Reimplemented from PowerElement.

Definition at line 531 of file Machines.cpp.

{
    std::vector<wxPoint2DDouble> edges;
    switch (m_pfDirection) {
    case PowerFlowDirection::PF_NONE: {
        m_powerFlowArrow.clear();
    } break;
    case PowerFlowDirection::PF_TO_BUS: {
        edges.push_back(m_pointList[2]);
        edges.push_back(m_pointList[1]);
    } break;
    case PowerFlowDirection::PF_TO_ELEMENT: {
        edges.push_back(m_pointList[1]);
        edges.push_back(m_pointList[2]);
    } break;
    default:
        break;
    }
 
    CalculatePowerFlowPts(edges);
}

◆ UpdateSwitchesPosition()

void Machines::UpdateSwitchesPosition ( )

overridevirtual

Reimplemented from PowerElement.

Definition at line 239 of file Machines.cpp.

{
    if (m_parentList[0]) {
        m_pointList[1] = GetSwitchPoint(m_parentList[0], m_pointList[0], m_pointList[2]);
    }
    else {
        m_pointList[1] = m_pointList[0];
    }
    UpdateSwitches();
}

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

Project/elements/powerElement/Machines.h
Project/elements/powerElement/Machines.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SyncMachineModel

Constructor & Destructor Documentation

◆ Machines()

◆ ~Machines()

Member Function Documentation

◆ AddParent()

◆ AlignToGrid()

◆ Contains()

◆ DrawDC() [1/2]

◆ DrawDC() [2/2]

◆ DrawDCSymbol() [1/2]

◆ DrawDCSymbol() [2/2]

◆ Intersects()

◆ Move()

◆ MoveNode()

◆ NodeContains()

◆ RemoveParent()

◆ Rotate()

◆ RotateNode()

◆ SetNodeParent()

◆ SetPowerFlowDirection()

◆ StartMove()

◆ UpdateNodes()

◆ UpdatePowerFlowArrowsPosition()

◆ UpdateSwitchesPosition()