Abstract class for shunt power elements. More...

#include <Shunt.h>

Inheritance diagram for Shunt:

[legend]

Collaboration diagram for Shunt:

[legend]

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

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	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 void	SetPowerFlowDirection (PowerFlowDirection pfDirection)
	Set the direction of the power flow.

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 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 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 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 void	Rotate (bool clockwise=true)
	Rotate the element.

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)

Protected Member Functions
void	DrawDCGround (wxPoint2DDouble position, wxGraphicsContext *gc) const

void	DrawDCGround (wxPoint2DDouble position, wxDC &dc) const

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 shunt power elements.

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

Date: 06/10/2017

Definition at line 31 of file Shunt.h.

Constructor & Destructor Documentation

◆ Shunt()

Shunt::Shunt ( )

Definition at line 20 of file Shunt.cpp.

20: PowerElement() {}

PowerElement::PowerElement

PowerElement()

Constructor.

Definition PowerElement.cpp:24

◆ ~Shunt()

Shunt::~Shunt ( )

Definition at line 21 of file Shunt.cpp.

21{}

Member Function Documentation

◆ AlignToGrid()

void Shunt::AlignToGrid ( double gridSize = 20.0 )

overridevirtual

Reimplemented from Element.

Definition at line 46 of file Shunt.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;
    SetPosition(m_position);
 
    // 2. Move the shunt geometry together with m_position.
    // Point 0 = bus connection.
    // Point 1 = switch.
    // Point 2+ = shunt geometry.
    //
    // Point 0 is not moved here because it must be aligned  with the bus in the next step.
    for (size_t i = 2; i < m_pointList.size(); ++i) {
        m_pointList[i] += delta;
    }
 
    // 3. Align the bus connection point (m_pointList[0]) with the reference point (m_pointList[2]).
    //
    // The alignment is completely independent of m_angle.
    // m_pointList[2] determines the position 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 to 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 new connection point is located at the same longitudinal position as p2 and exactly on the center line of the bus.
        wxPoint2DDouble candidateLocal(p2Local.m_x, 0.0);
 
        // The candidate must remain within the length of 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;
    }
 
    // 4. Update dependent geometry.
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ Contains()

virtual bool Shunt::Contains ( wxPoint2DDouble position ) const

inlinevirtual

Checks if the element contains a position.

Parameters

position Position to be checked.

Implements Element.

Reimplemented in Capacitor, EMTElement, HarmCurrent, and Inductor.

Definition at line 37 of file Shunt.h.

37{ return m_rect.Contains(position); }

◆ DrawDCGround() [1/2]

void Shunt::DrawDCGround	(	wxPoint2DDouble	position,
		wxDC &	dc
	)		const

protected

Definition at line 256 of file Shunt.cpp.

{
    wxPoint groundPts[8];
    wxPoint2DDouble p;
 
    p = position;
    groundPts[0] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(0, 10);
    groundPts[1] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(-10, 10);
    groundPts[2] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(10, 10);
    groundPts[3] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(-6, 15);
    groundPts[4] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(6, 15);
    groundPts[5] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(-3, 20);
    groundPts[6] = RotateAround(p, m_position, m_angle);
    p = position + wxPoint2DDouble(3, 20);
    groundPts[7] = RotateAround(p, m_position, m_angle);
 
    dc.DrawLines(2, &groundPts[0]);
    dc.DrawLines(2, &groundPts[2]);
    dc.DrawLines(2, &groundPts[4]);
    dc.DrawLines(2, &groundPts[6]);
}

◆ DrawDCGround() [2/2]

void Shunt::DrawDCGround	(	wxPoint2DDouble	position,
		wxGraphicsContext *	gc
	)		const

protected

Definition at line 238 of file Shunt.cpp.

{
    std::vector<wxPoint2DDouble> groundPts;
    groundPts.push_back(position);
    groundPts.push_back(position + wxPoint2DDouble(0, 10));
    groundPts.push_back(position + wxPoint2DDouble(-10, 10));
    groundPts.push_back(position + wxPoint2DDouble(10, 10));
    groundPts.push_back(position + wxPoint2DDouble(-6, 15));
    groundPts.push_back(position + wxPoint2DDouble(6, 15));
    groundPts.push_back(position + wxPoint2DDouble(-3, 20));
    groundPts.push_back(position + wxPoint2DDouble(3, 20));
 
    gc->StrokeLines(2, &groundPts[0]);
    gc->StrokeLines(2, &groundPts[2]);
    gc->StrokeLines(2, &groundPts[4]);
    gc->StrokeLines(2, &groundPts[6]);
}

◆ Intersects()

virtual bool Shunt::Intersects ( wxRect2DDouble rect ) const

inlinevirtual

Check if the element's rect intersects other rect.

Parameters

rect	Rect to check intersection.

Implements Element.

Reimplemented in Capacitor, EMTElement, HarmCurrent, and Inductor.

Definition at line 38 of file Shunt.h.

38{ return m_rect.Intersects(rect); }

Here is the caller graph for this function:

◆ Move()

void Shunt::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 33 of file Shunt.cpp.

{
    SetPosition(m_movePos + position - m_moveStartPt);
    for (int i = 2; i < (int)m_pointList.size(); i++) {
        m_pointList[i] = m_movePts[i] + position - m_moveStartPt;
    }
    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 Shunt::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 113 of file Shunt.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 Shunt::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 153 of file Shunt.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 Shunt::RemoveParent ( Element * parent )

virtual

Remove a parent.

Parameters

parent Parent to be removed.

Reimplemented from Element.

Definition at line 143 of file Shunt.cpp.

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

◆ RotateNode()

void Shunt::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 211 of file Shunt.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 Shunt::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 167 of file Shunt.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:

◆ StartMove()

void Shunt::StartMove ( wxPoint2DDouble position )

virtual

Update the element attributes related to the movement.

Parameters

position Start move position.

Reimplemented from Element.

Definition at line 136 of file Shunt.cpp.

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

◆ UpdateNodes()

void Shunt::UpdateNodes ( )

virtual

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

Reimplemented from Element.

Definition at line 195 of file Shunt.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 Shunt::UpdatePowerFlowArrowsPosition ( )

overridevirtual

Reimplemented from PowerElement.

Definition at line 284 of file Shunt.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 Shunt::UpdateSwitchesPosition ( )

overridevirtual

Reimplemented from PowerElement.

Definition at line 22 of file Shunt.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/Shunt.h
Project/elements/powerElement/Shunt.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Shunt()

◆ ~Shunt()

Member Function Documentation

◆ AlignToGrid()

◆ Contains()

◆ DrawDCGround() [1/2]

◆ DrawDCGround() [2/2]

◆ Intersects()

◆ Move()

◆ MoveNode()

◆ NodeContains()

◆ RemoveParent()

◆ RotateNode()

◆ SetNodeParent()

◆ StartMove()

◆ UpdateNodes()

◆ UpdatePowerFlowArrowsPosition()

◆ UpdateSwitchesPosition()