Power line element. More...

#include <Line.h>

Inheritance diagram for Line:

[legend]

Collaboration diagram for Line:

[legend]

Public Member Functions
	Line (wxString name)

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

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

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

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

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

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

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 wxCursor	GetBestPickboxCursor () const
	Get the best cursor to shown to the user when the mouse is above a pickbox.

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

virtual bool	AddParent (Element *parent, wxPoint2DDouble position)
	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	Intersects (wxRect2DDouble rect) const
	Check if the element's rect intersects other rect.

virtual void	MovePickbox (wxPoint2DDouble position)
	Move the pickbox.

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	AddPoint (wxPoint2DDouble point)
	Add point to the list of points that connect the element to the bus.

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

virtual wxString	GetTipText () const
	Get the tip text.

virtual void	RemoveNode (wxPoint2DDouble point)

virtual void	AddNode (wxPoint2DDouble point)

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

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

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

virtual bool	ShowForm (wxWindow parent, Element element)
	Show element data form.

virtual LineElectricalData	GetElectricalData () const

virtual LineElectricalData	GetPUElectricalData (double systemBasePower)

virtual void	SetElectricalData (LineElectricalData electricalData)

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

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

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

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

Public Member Functions inherited from Branch
virtual void	Draw (wxPoint2DDouble translation, double scale) const

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

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

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

virtual void	UpdateSwitchesPosition ()

virtual void	UpdateSwitches ()
	Update the switch position.

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	DrawDCSwitches (wxGraphicsContext *gc) const
	Draw switch.

virtual void	DrawDCSwitches (wxDC &dc) const

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

virtual void	DrawDCPowerFlowPts (wxGraphicsContext *gc) const
	Draw power flow arrows.

virtual void	DrawDCPowerFlowPts (wxDC &dc) const

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)

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

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

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.

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 void	AddParent (Element *parent)
	Add a parent to the element.

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

void	SetParent (Element *parent, int num)

void	SetChild (Element *child, int num)

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

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	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 void	GeneralMenuItens (wxMenu &menu)
	Insert general itens to context menu.

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 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	UpdatePowerFlowArrowsPosition ()

Protected Attributes
LineElectricalData	m_electricalData

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

wxColour	m_selectionColour

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.

Detailed Description

Power line element.

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

Date: 06/10/2017

Definition at line 63 of file Line.h.

Constructor & Destructor Documentation

◆ Line() [1/2]

Line::Line ( )

Definition at line 21 of file Line.cpp.

           : Branch()
{
    m_elementType = TYPE_LINE;
    for (int i = 0; i < 2; i++) {
        for (int j = 0; j < 3; j++) { m_electricalData.faultCurrent[i][j] = std::complex<double>(0.0, 0.0); }
    }
}

◆ Line() [2/2]

Line::Line ( wxString name )

Definition at line 29 of file Line.cpp.

                        : Branch()
{
    m_elementType = TYPE_LINE;
    for (int i = 0; i < 2; i++) {
        for (int j = 0; j < 3; j++) { m_electricalData.faultCurrent[i][j] = std::complex<double>(0.0, 0.0); }
    }
    m_electricalData.name = name;
}

◆ ~Line()

Line::~Line ( )

Definition at line 37 of file Line.cpp.

37{}

Member Function Documentation

◆ AddNode()

void Line::AddNode ( wxPoint2DDouble point )

virtual

Definition at line 492 of file Line.cpp.

{
    int segmentNumber = 0;
    PointToLineDistance(point, &segmentNumber);
    if (segmentNumber > 0 && segmentNumber < (int)m_pointList.size() - 2) {
        m_pointList.insert(m_pointList.begin() + segmentNumber + 1, point);
    }
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ AddParent()

bool Line::AddParent	(	Element *	parent,
		wxPoint2DDouble	position
	)

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 276 of file Line.cpp.

{
    if (parent) {
        // First bus.
        if (m_parentList.size() == 0) {
            m_position = position;
            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 = parent->RotateAtPosition(parentPt, parent->GetAngle());  // Rotate back.
            m_pointList.push_back(parentPt);                                    // First point
            m_pointList.push_back(GetSwitchPoint(parent, parentPt, m_position));
 
            wxRect2DDouble genRect(0, 0, 0, 0);
            m_switchRect.push_back(genRect);
            UpdateSwitches();
 
            Bus* parentBus = static_cast<Bus*>(parent);
            m_electricalData.nominalVoltage = parentBus->GetElectricalData().nominalVoltage;
            m_electricalData.nominalVoltageUnit = parentBus->GetElectricalData().nominalVoltageUnit;
 
            return false;
        }
        // Second bus.
        else if (parent != m_parentList[0]) {
            Bus* parentBus = static_cast<Bus*>(parent);
            if (m_electricalData.nominalVoltage != parentBus->GetElectricalData().nominalVoltage ||
                m_electricalData.nominalVoltageUnit != parentBus->GetElectricalData().nominalVoltageUnit) {
                wxMessageDialog msgDialog(nullptr,
                    _("Unable to connect two buses with different nominal voltages.\n"
                        "Use a transformer or edit the bus properties."),
                    _("Error"), wxOK | wxCENTRE | wxICON_ERROR);
                msgDialog.ShowModal();
                return false;
            }
 
            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 = parent->RotateAtPosition(parentPt, parent->GetAngle());  // Rotate back.
 
            // Set first switch point.
            wxPoint2DDouble secondPoint = parentPt;
            if (m_pointList.size() > 2) { secondPoint = m_pointList[2]; }
            m_pointList[1] = GetSwitchPoint(m_parentList[0], m_pointList[0], secondPoint);
 
            // Set the second switch point.
            m_pointList.push_back(GetSwitchPoint(parent, parentPt, m_pointList[m_pointList.size() - 1]));
 
            m_pointList.push_back(parentPt);  // Last point.
 
            wxRect2DDouble genRect(0, 0, 0, 0);
            m_switchRect.push_back(genRect);
            UpdateSwitches();
 
            SetInserted();
            UpdatePowerFlowArrowsPosition();
            return true;
        }
    }
    return false;
}

Here is the call graph for this function:

◆ AddPoint()

void Line::AddPoint ( wxPoint2DDouble point )

virtual

Add point to the list of points that connect the element to the bus.

Parameters

point Point to be added.

Reimplemented from Branch.

Definition at line 373 of file Line.cpp.

{
    if (m_parentList.size() != 0) { m_pointList.push_back(point); }
}

◆ CalculateBoundaries()

void Line::CalculateBoundaries	(	wxPoint2DDouble &	leftUp,
		wxPoint2DDouble &	rightBottom
	)		const

virtual

Calculate the element boundaries.

Parameters

leftUp	Top-left position of the element.
rightBottom	Bottom-right position of the element.

Reimplemented from Element.

Definition at line 503 of file Line.cpp.

{
    if (m_pointList.size() > 0) {
        // Check points list boundaries.
        leftUp = m_pointList[0];
        rightBottom = m_pointList[0];
        for (int i = 1; i < (int)m_pointList.size(); i++) {
            if (m_pointList[i].m_x < leftUp.m_x) leftUp.m_x = m_pointList[i].m_x;
            if (m_pointList[i].m_y < leftUp.m_y) leftUp.m_y = m_pointList[i].m_y;
            if (m_pointList[i].m_x > rightBottom.m_x) rightBottom.m_x = m_pointList[i].m_x;
            if (m_pointList[i].m_y > rightBottom.m_y) rightBottom.m_y = m_pointList[i].m_y;
        }
    }
}

◆ Contains()

bool Line::Contains ( wxPoint2DDouble position ) const

virtual

Checks if the element contains a position.

Parameters

position Position to be checked.

Reimplemented from Branch.

Definition at line 38 of file Line.cpp.

{
    if (PointToLineDistance(position) < 5.0) { return true; }
    return false;
}

Here is the call graph for this function:

◆ DrawDC() [1/2]

void Line::DrawDC	(	wxPoint2DDouble	translation,
		double	scale,
		wxDC &	dc
	)		const

virtual

Draw the element using wxDC.

Parameters

translation	Translation of the system.
scale	Scale of the system.
dc	Device context.

Reimplemented from Element.

Definition at line 182 of file Line.cpp.

{
 
    wxColour elementColour;
    if (m_online) {
        if (m_dynEvent)
            elementColour = m_dynamicEventColour;
        else
            elementColour = m_onlineElementColour;
 
    }
    else
        elementColour = m_offlineElementColour;
 
    std::vector<wxPoint> pointList;
    for (auto pt : m_pointList) {
        pointList.emplace_back(pt.m_x, pt.m_y);
    }
    //if (!m_inserted && pointList.size() > 0) {
    //  wxPoint secondPoint = wxPoint(m_position.m_x, m_position.m_y);
    //  if (pointList.size() > 2) { secondPoint = pointList[2]; }
    //  wxPoint2DDouble swPoint = GetSwitchPoint(m_parentList[0], pointList[0], secondPoint)
    //  pointList[1] = wxPoint(m_position.m_x, m_position.m_y);
    //  pointList.push_back(m_position);
    //}
 
    // Line selected (Layer 1).
    if (m_selected) {
        dc.SetPen(wxPen(m_selectionColour, 2 + m_borderSize * 2.0));
        dc.SetBrush(*wxTRANSPARENT_BRUSH);
        if (pointList.size() > 0)
            dc.DrawLines(pointList.size(), &pointList[0]);
 
        // Draw nodes selection.
        dc.SetPen(*wxTRANSPARENT_PEN);
        dc.SetBrush(wxBrush(m_selectionColour));
        if (pointList.size() > 0) {
            DrawDCCircle(pointList[0], 5.0 + m_borderSize / scale, dc);
            if (m_inserted) { DrawDCCircle(pointList[pointList.size() - 1], 5.0 + m_borderSize / scale, dc); }
        }
    }
 
    // Draw line (Layer 2)
    dc.SetPen(wxPen(elementColour, 2));
    dc.SetBrush(*wxTRANSPARENT_BRUSH);
    if (pointList.size() > 0)
        dc.DrawLines(pointList.size(), &pointList[0]);
 
    if (m_inserted) {
        DrawDCSwitches(dc);
        DrawDCPowerFlowPts(dc);
    }
 
    // Draw nodes.
    dc.SetPen(*wxTRANSPARENT_PEN);
    dc.SetBrush(wxBrush(elementColour));
    if (pointList.size() > 0) {
        DrawDCCircle(pointList[0], 5.0, dc);
        if (m_inserted) { DrawDCCircle(pointList[pointList.size() - 1], 5.0, dc); }
    }
 
    // Draw pickboxes (Layer 3).
    //if (m_showPickbox) {
    //  gc->PushState();
    //  gc->SetTransform(identityMatrix);
    //
    //  for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
    //      DrawDCPickbox(WorldToScreen(m_pointList[i], translation - wxPoint2DDouble(4 / scale, 4 / scale), scale), gc);
    //  }
    //
    //  gc->PopState();
    //}
}

Here is the call graph for this function:

◆ DrawDC() [2/2]

void Line::DrawDC	(	wxPoint2DDouble	translation,
		double	scale,
		wxGraphicsContext *	gc
	)		const

virtual

Draw the element using GDI+.

Parameters

translation	Translation of the system.
scale	Scale of the system.
gc	Graphics context

Reimplemented from Element.

Definition at line 108 of file Line.cpp.

{
    //gc->SetBrush(*wxTRANSPARENT_BRUSH);
 
    wxGraphicsMatrix identityMatrix = gc->GetTransform();
    identityMatrix.Set(); // Set to identity
 
    wxColour elementColour;
    if (m_online) {
        if (m_dynEvent)
            elementColour = m_dynamicEventColour;
        else
            elementColour = m_onlineElementColour;
 
    }
    else
        elementColour = m_offlineElementColour;
 
    std::vector<wxPoint2DDouble> pointList = m_pointList;
    if (!m_inserted && pointList.size() > 0) {
        wxPoint2DDouble secondPoint = m_position;
        if (pointList.size() > 2) { secondPoint = pointList[2]; }
        pointList[1] = GetSwitchPoint(m_parentList[0], pointList[0], secondPoint);
        pointList.push_back(m_position);
    }
 
    // Line selected (Layer 1).
    if (m_selected) {
        gc->SetPen(wxPen(m_selectionColour, 2 + m_borderSize * 2.0));
        gc->SetBrush(*wxTRANSPARENT_BRUSH);
        if (pointList.size() > 0)
            gc->StrokeLines(pointList.size(), &pointList[0]);
 
        // Draw nodes selection.
        gc->SetPen(*wxTRANSPARENT_PEN);
        gc->SetBrush(wxBrush(m_selectionColour));
        if (pointList.size() > 0) {
            DrawDCCircle(pointList[0], 5.0 + m_borderSize / scale, 10, gc);
            if (m_inserted) { DrawDCCircle(pointList[pointList.size() - 1], 5.0 + m_borderSize / scale, 10, gc); }
        }
    }
 
    // Draw line (Layer 2)
    gc->SetPen(wxPen(elementColour, 2));
    gc->SetBrush(*wxTRANSPARENT_BRUSH);
    if (pointList.size() > 0)
        gc->StrokeLines(pointList.size(), &pointList[0]);
 
    if (m_inserted) {
        DrawDCSwitches(gc);
        DrawDCPowerFlowPts(gc);
    }
 
    // Draw nodes.
    gc->SetPen(*wxTRANSPARENT_PEN);
    gc->SetBrush(wxBrush(elementColour));
    if (pointList.size() > 0) {
        DrawDCCircle(pointList[0], 5.0, 10, gc);
        if (m_inserted) { DrawDCCircle(pointList[pointList.size() - 1], 5.0, 10, gc); }
    }
 
    // Draw pickboxes (Layer 3).
    if (m_showPickbox) {
        gc->PushState();
        gc->SetTransform(identityMatrix);
 
        for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
            DrawDCPickbox(WorldToScreen(m_pointList[i], translation - wxPoint2DDouble(4 / scale, 4 / scale), scale), gc);
        }
 
        gc->PopState();
    }
}

Here is the call graph for this function:

◆ GetBestPickboxCursor()

virtual wxCursor Line::GetBestPickboxCursor ( ) const

inlinevirtual

Get the best cursor to shown to the user when the mouse is above a pickbox.

Returns: Cursor.

Reimplemented from Branch.

Definition at line 77 of file Line.h.

77{ return wxCURSOR_SIZING; }

◆ GetContextMenu()

bool Line::GetContextMenu ( wxMenu & menu )

virtual

Get the element contex menu.

Parameters

menu	menu that will be inserted the element itens.

Returns: True if was possible to build the menu, false otherwise.

Reimplemented from Branch.

Definition at line 428 of file Line.cpp.

{
    //wxFileName exeFileName(wxStandardPaths::Get().GetExecutablePath());
    //wxString exePath = exeFileName.GetPath();
 
    menu.Append(ID_EDIT_ELEMENT, _("Edit line"));
 
    wxString busName[2] = { "?", "?" };
    if (m_parentList.size() == 2) {
        int i = 0;
        for (Element* element : m_parentList) {
            if (element) {
                Bus* bus = static_cast<Bus*>(element);
                busName[i] = bus->GetElectricalData().name;
            }
            i++;
        }
    }
 
    wxMenu* textMenu = new wxMenu();
 
    textMenu->Append(ID_TXT_NAME, _("Name"));
    textMenu->Append(ID_TXT_BRANCH_ACTIVE_POWER_1_2, _("Active power (") + busName[0] + _(" to ") + busName[1] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_ACTIVE_POWER_2_1, _("Active power (") + busName[1] + _(" to ") + busName[0] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_REACTIVE_POWER_1_2, _("Reactive power (") + busName[0] + _(" to ") + busName[1] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_REACTIVE_POWER_2_1, _("Reactive power (") + busName[1] + _(" to ") + busName[0] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_LOSSES, _("Losses"));
    textMenu->Append(ID_TXT_BRANCH_CURRENT_1_2, _("Current (") + busName[0] + _(" to ") + busName[1] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_CURRENT_2_1, _("Current (") + busName[1] + _(" to ") + busName[0] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_FAULT_CURRENT_1_2, _("Fault current (") + busName[0] + _(" to ") + busName[1] + wxT(")"));
    textMenu->Append(ID_TXT_BRANCH_FAULT_CURRENT_2_1, _("Fault current (") + busName[1] + _(" to ") + busName[0] + wxT(")"));
    textMenu->SetClientData(menu.GetClientData());
    menu.AppendSubMenu(textMenu, _("Add text"));
 
    if (m_activePickboxID == ID_PB_NONE) {
        wxMenuItem* addNodeItem = new wxMenuItem(&menu, ID_LINE_ADD_NODE, _("Insert node"));
        addNodeItem->SetBitmap(wxImage(Paths::GetDataPath() + "/images/menu/addNode16.png"));
        menu.Append(addNodeItem);
    }
    else {
        wxMenuItem* addNodeItem = new wxMenuItem(&menu, ID_LINE_REMOVE_NODE, _("Remove node"));
        addNodeItem->SetBitmap(wxImage(Paths::GetDataPath() + "/images/menu/removeNode16.png"));
        menu.Append(addNodeItem);
    }
    wxMenuItem* deleteItem = new wxMenuItem(&menu, ID_DELETE, _("Delete"));
    deleteItem->SetBitmap(wxImage(Paths::GetDataPath() + "/images/menu/delete16.png"));
    menu.Append(deleteItem);
    return true;
}

◆ GetCopy()

Element * Line::GetCopy ( )

virtual

Get a the element copy.

Returns: Copy of the element.

Reimplemented from Element.

Definition at line 666 of file Line.cpp.

{
    Line* copy = new Line();
    *copy = *this;
    return copy;
}

◆ GetElectricalData()

virtual LineElectricalData Line::GetElectricalData ( ) const

inlinevirtual

Definition at line 92 of file Line.h.

92{ return m_electricalData; }

◆ GetPUElectricalData()

LineElectricalData Line::GetPUElectricalData ( double systemBasePower )

virtual

Definition at line 710 of file Line.cpp.

{
    LineElectricalData data = m_electricalData;
    double lineBasePower = GetValueFromUnit(data.nominalPower, data.nominalPowerUnit);
    double baseVoltage = GetValueFromUnit(data.nominalVoltage, data.nominalVoltageUnit);
    double systemBaseImpedance = (baseVoltage * baseVoltage) / systemBasePower;
    double lineBaseImpedance = (baseVoltage * baseVoltage) / lineBasePower;
 
    // Resistance
    double r = data.resistance;
    if (data.resistanceUnit == ElectricalUnit::UNIT_OHM_km) data.resistance = r * data.lineSize / systemBaseImpedance;
    else if (data.resistanceUnit == ElectricalUnit::UNIT_PU) {
        if (data.useLinePower) data.resistance = (r * lineBaseImpedance) / systemBaseImpedance;
    }
    else { // Ohm
        data.resistance = r / systemBaseImpedance;
    }
    data.resistanceUnit = ElectricalUnit::UNIT_PU;
 
    // Inductive reactance
    double x = data.indReactance;
    if (data.indReactanceUnit == ElectricalUnit::UNIT_OHM_km) data.indReactance = x * data.lineSize / systemBaseImpedance;
    else if (data.indReactanceUnit == ElectricalUnit::UNIT_PU) {
        if (data.useLinePower) data.indReactance = (x * lineBaseImpedance) / systemBaseImpedance;
    }
    else { // Ohm
        data.indReactance = x / systemBaseImpedance;
    }
    data.indReactanceUnit = ElectricalUnit::UNIT_PU;
 
    // Capacitive susceptance
    double b = data.capSusceptance;
    if (data.capSusceptanceUnit == ElectricalUnit::UNIT_S_km) data.capSusceptance = b * data.lineSize * systemBaseImpedance;
    else if (data.capSusceptanceUnit == ElectricalUnit::UNIT_PU) {
        if (data.useLinePower) data.capSusceptance = (b / lineBaseImpedance) * systemBaseImpedance;
    }
    else { // S
        data.capSusceptance = b * systemBaseImpedance;
    }
    data.capSusceptanceUnit = ElectricalUnit::UNIT_PU;
 
    // Fault
 
    // Zero seq. resistance
    double r0 = data.zeroResistance;
    if (data.useLinePower) data.zeroResistance = (r0 * lineBaseImpedance) / systemBaseImpedance;
 
    // Zero seq. ind. reactance
    double x0 = data.zeroIndReactance;
    if (data.useLinePower) data.zeroIndReactance = (x0 * lineBaseImpedance) / systemBaseImpedance;
 
    // Zero seq. cap. susceptance
    double b0 = data.zeroCapSusceptance;
    if (data.useLinePower) data.zeroCapSusceptance = (b0 / lineBaseImpedance) * systemBaseImpedance;
 
    if (!m_online) {
        data.powerFlow[0] = std::complex<double>(0, 0);
        data.powerFlow[1] = std::complex<double>(0, 0);
        data.faultCurrent[0][0] = std::complex<double>(0, 0);
        data.faultCurrent[0][1] = std::complex<double>(0, 0);
        data.faultCurrent[0][2] = std::complex<double>(0, 0);
        data.faultCurrent[1][0] = std::complex<double>(0, 0);
        data.faultCurrent[1][1] = std::complex<double>(0, 0);
        data.faultCurrent[1][2] = std::complex<double>(0, 0);
    }
 
    return data;
}

◆ GetTipText()

wxString Line::GetTipText ( ) const

virtual

Get the tip text.

Returns: Tip text.

Reimplemented from Element.

Definition at line 673 of file Line.cpp.

{
    wxString tipText = m_electricalData.name;
 
    if (m_online) {
        tipText += "\n";
        int busNumber[2];
        busNumber[0] = static_cast<Bus*>(m_parentList[0])->GetElectricalData().number + 1;
        busNumber[1] = static_cast<Bus*>(m_parentList[1])->GetElectricalData().number + 1;
 
        tipText += _("\nP") + wxString::Format("(%d-%d) = ", busNumber[0], busNumber[1]) +
            wxString::FromDouble(m_electricalData.powerFlow[0].real(), 5) + _(" p.u.");
        tipText += _("\nQ") + wxString::Format("(%d-%d) = ", busNumber[0], busNumber[1]) +
            wxString::FromDouble(m_electricalData.powerFlow[0].imag(), 5) + _(" p.u.");
        tipText += _("\nP") + wxString::Format("(%d-%d) = ", busNumber[1], busNumber[0]) +
            wxString::FromDouble(m_electricalData.powerFlow[1].real(), 5) + _(" p.u.");
        tipText += _("\nQ") + wxString::Format("(%d-%d) = ", busNumber[1], busNumber[0]) +
            wxString::FromDouble(m_electricalData.powerFlow[1].imag(), 5) + _(" p.u.");
 
        if (!m_electricalData.harmonicOrder.empty()) {
            tipText += _("\n\nHarmonic currents:");
            int i = 0;
            for (auto& hCurrent1 : m_electricalData.harmonicCurrent[0]) {
                auto& hCurrent2 = m_electricalData.harmonicCurrent[1][i];
                wxString i1, i2;
                i1.Printf(_("\nIh(%d)(%d-%d) = %.5e%s%.2f%s p.u."), m_electricalData.harmonicOrder[i], busNumber[0], busNumber[1], std::abs(hCurrent1), wxString(L'\u2220'), wxRadToDeg(std::arg(hCurrent1)), wxString(L'\u00B0'));
                i2.Printf(_("\nIh(%d)(%d-%d) = %.5e%s%.2f%s p.u."), m_electricalData.harmonicOrder[i], busNumber[1], busNumber[0], std::abs(hCurrent2), wxString(L'\u2220'), wxRadToDeg(std::arg(hCurrent2)), wxString(L'\u00B0'));
 
                tipText += i1 + i2;
                i++;
            }
        }
    }
 
    return tipText;
}

◆ Intersects()

bool Line::Intersects ( wxRect2DDouble rect ) const

virtual

Check if the element's rect intersects other rect.

Parameters

rect	Rect to check intersection.

Reimplemented from Branch.

Definition at line 342 of file Line.cpp.

{
    for (auto it = m_pointList.begin(); it != m_pointList.end(); ++it) {
        if (rect.Contains(*it)) return true;
    }
    return false;
}

◆ Move()

void Line::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 Branch.

Definition at line 256 of file Line.cpp.

{
    if (!m_parentList[0]) {
        m_pointList[0] = m_movePts[0] + position - m_moveStartPt;
        UpdateSwitchesPosition();
        UpdatePowerFlowArrowsPosition();
    }
    if (!m_parentList[1]) {
        m_pointList[m_pointList.size() - 1] = m_movePts[m_pointList.size() - 1] + position - m_moveStartPt;
        UpdateSwitchesPosition();
        UpdatePowerFlowArrowsPosition();
    }
 
    if (!m_parentList[0] && !m_parentList[1]) {
        for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
            m_pointList[i] = m_movePts[i] + position - m_moveStartPt;
        }
    }
}

◆ MoveNode()

void Line::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 Branch.

Definition at line 384 of file Line.cpp.

{
    if (parent) {
        // First bus.
        if (parent == m_parentList[0]) {
            m_pointList[0] = m_movePts[0] + position - m_moveStartPt;
        }
        // Second bus.
        else if (parent == m_parentList[1]) {
            m_pointList[m_pointList.size() - 1] = m_movePts[m_pointList.size() - 1] + position - m_moveStartPt;
        }
 
        // If the line is selected, move all the points, except the switches and buses points.
        if (m_selected) {
            for (int i = 2; i < (int)m_pointList.size() - 1; i++) {
                m_pointList[i] = m_movePts[i] + position - m_moveStartPt;
            }
        }
    }
    else {
        // If parent is setted to nullptr for the firts time, remove the parent child
        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;
            }
        }
        else if (m_activeNodeID == 2) {
            m_pointList[m_pointList.size() - 1] = m_movePts[m_pointList.size() - 1] + position - m_moveStartPt;
            if (m_parentList[1]) {
                m_parentList[1]->RemoveChild(this);
                m_parentList[1] = nullptr;
                m_online = false;
            }
        }
    }
 
    // Recalculate switches positions
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ MovePickbox()

void Line::MovePickbox ( wxPoint2DDouble position )

virtual

Move the pickbox.

Parameters

position position that the pickbox will be moved.

Reimplemented from Branch.

Definition at line 349 of file Line.cpp.

{
    if (m_activePickboxID == ID_PB_NONE) return;
 
    for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
        if (m_activePickboxID == i) {
            m_pointList[i] = m_movePts[i] + position - m_moveStartPt;
            UpdateSwitchesPosition();
            UpdatePowerFlowArrowsPosition();
        }
    }
}

◆ OpenElement()

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

virtual

Reimplemented from PowerElement.

Definition at line 848 of file Line.cpp.

{
    auto cadPropNode = elementNode->first_node("CADProperties");
    if (!cadPropNode) return false;
 
    // Get nodes points
    std::vector<wxPoint2DDouble> ptsList;
    auto nodePosList = cadPropNode->first_node("NodeList");
    if (!nodePosList) return false;
    auto nodePos = nodePosList->first_node("Node");
    while (nodePos) {
        double nodePosX = XMLParser::GetNodeValueDouble(nodePos, "X");
        double nodePosY = XMLParser::GetNodeValueDouble(nodePos, "Y");
        ptsList.push_back(wxPoint2DDouble(nodePosX, nodePosY));
        nodePos = nodePos->next_sibling("Node");
    }
 
    // Get parents IDs
    auto parentIDList = cadPropNode->first_node("ParentIDList");
    if (!parentIDList) return false;
    auto parentNode = parentIDList->first_node("ParentID");
    long parentID[2] = { -1, -1 };
    while (parentNode) {
        long index = 0;
        wxString(parentNode->first_attribute("ID")->value()).ToCLong(&index);
        wxString(parentNode->value()).ToCLong(&parentID[index]);
        parentNode = parentNode->next_sibling("ParentID");
    }
 
    std::vector<wxPoint2DDouble> nodePtsList;            // List of node points
    nodePtsList.push_back(ptsList[0]);                   // First point on the list
    nodePtsList.push_back(ptsList[ptsList.size() - 1]);  // Last point on the list
 
    // List of dummy buses to set not connected nodes properly
    std::vector<Bus*> dummyBusList;
    for (unsigned int i = 0; i < nodePtsList.size(); ++i) {
        if (parentID[i] == -1)  // No parent connected
        {
            Bus* dummyBus = new Bus(nodePtsList[i]);
            dummyBusList.push_back(dummyBus);
            AddParent(dummyBus, nodePtsList[i]);
        }
        else {  // Parent connected (necessarily a bus, get from bus list)
            AddParent(parentList[parentID[i]], nodePtsList[i]);
        }
    }
 
    // Add the others nodes (if exists)
    std::vector<wxPoint2DDouble> midPts;
    for (unsigned int i = 1; i < ptsList.size() - 1; i++) midPts.push_back(ptsList[i]);
    m_pointList.insert(m_pointList.begin() + 2, midPts.begin(), midPts.end());
    SetPointList(m_pointList);
 
    // Remove dummy buses
    for (auto it = dummyBusList.begin(), itEnd = dummyBusList.end(); it != itEnd; ++it) {
        RemoveParent(*it);
        delete* it;
    }
    dummyBusList.clear();
 
    auto electricalProp = elementNode->first_node("ElectricalProperties");
    if (!electricalProp) return false;
 
    SetOnline(XMLParser::GetNodeValueInt(electricalProp, "IsOnline"));
    m_electricalData.name = electricalProp->first_node("Name")->value();
    m_electricalData.nominalVoltage = XMLParser::GetNodeValueDouble(electricalProp, "NominalVoltage");
    m_electricalData.nominalVoltageUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "NominalVoltage", "UnitID"));
    m_electricalData.nominalPower = XMLParser::GetNodeValueDouble(electricalProp, "NominalPower");
    m_electricalData.nominalPowerUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "NominalPower", "UnitID"));
    m_electricalData.resistance = XMLParser::GetNodeValueDouble(electricalProp, "Resistance");
    m_electricalData.resistanceUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "Resistance", "UnitID"));
    m_electricalData.indReactance = XMLParser::GetNodeValueDouble(electricalProp, "IndReactance");
    m_electricalData.indReactanceUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "IndReactance", "UnitID"));
    m_electricalData.capSusceptance = XMLParser::GetNodeValueDouble(electricalProp, "CapSusceptance");
    m_electricalData.capSusceptanceUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "CapSusceptance", "UnitID"));
    m_electricalData.lineSize = XMLParser::GetNodeValueDouble(electricalProp, "LineSize");
    m_electricalData.useLinePower = XMLParser::GetNodeValueInt(electricalProp, "UseLinePower");
 
    auto fault = electricalProp->first_node("Fault");
    m_electricalData.zeroResistance = XMLParser::GetNodeValueDouble(fault, "ZeroResistance");
    m_electricalData.zeroIndReactance = XMLParser::GetNodeValueDouble(fault, "ZeroIndReactance");
    m_electricalData.zeroCapSusceptance = XMLParser::GetNodeValueDouble(fault, "ZeroCapSusceptance");
 
    if (!OpenSwitchingData(electricalProp)) return false;
    if (m_swData.swTime.size() != 0) SetDynamicEvent(true);
    return true;
}

◆ PickboxContains()

bool Line::PickboxContains ( wxPoint2DDouble position )

virtual

Check if a pickbox contains a point. If contains the attributes related to pickbox movement will be calculated.

Parameters

position Position to be checked.

Returns: True if the element constains the pickbox, false otherwise.

Reimplemented from Branch.

Definition at line 361 of file Line.cpp.

{
    for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
        wxRect2DDouble rect(m_pointList[i].m_x - 5.0, m_pointList[i].m_y - 5.0, 10.0, 10.0);
        if (rect.Contains(position)) {
            m_activePickboxID = i;
            return true;
        }
    }
    return false;
}

◆ RemoveNode()

void Line::RemoveNode ( wxPoint2DDouble point )

virtual

Definition at line 478 of file Line.cpp.

{
    if (PickboxContains(point)) {
        for (int i = 2; i < (int)m_pointList.size() - 2; i++) {
            if (m_activePickboxID == i) {
                m_pointList.erase(m_pointList.begin() + i);
                break;
            }
        }
    }
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ RotateNode()

void Line::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 Branch.

Definition at line 644 of file Line.cpp.

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

Here is the call graph for this function:

◆ SaveElement()

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

virtual

Reimplemented from Element.

Definition at line 779 of file Line.cpp.

{
    auto elementNode = XMLParser::AppendNode(doc, elementListNode, "Line");
    XMLParser::SetNodeAttribute(doc, elementNode, "ID", m_elementID);
    auto cadProp = XMLParser::AppendNode(doc, elementNode, "CADProperties");
    auto nodeList = XMLParser::AppendNode(doc, cadProp, "NodeList");
    int nodeID = 0;
    // Parse all the points.
    for (unsigned int i = 0; i < m_pointList.size(); i++) {
        // Don't save switch points, the method UpdateSwitchesPosition() calculate these points properly after open the
        // element
        if ((i != 1) && (i != m_pointList.size() - 2)) {
            auto nodePos = XMLParser::AppendNode(doc, nodeList, "Node");
            XMLParser::SetNodeAttribute(doc, nodePos, "ID", nodeID);
            auto nodePosX = XMLParser::AppendNode(doc, nodePos, "X");
            XMLParser::SetNodeValue(doc, nodePosX, m_pointList[i].m_x);
            auto nodePosY = XMLParser::AppendNode(doc, nodePos, "Y");
            XMLParser::SetNodeValue(doc, nodePosY, m_pointList[i].m_y);
            nodeID++;
        }
    }
 
    auto parentIDList = XMLParser::AppendNode(doc, cadProp, "ParentIDList");
    for (unsigned int i = 0; i < m_parentList.size(); i++) {
        if (m_parentList[i]) {
            auto parentID = XMLParser::AppendNode(doc, parentIDList, "ParentID");
            XMLParser::SetNodeAttribute(doc, parentID, "ID", static_cast<int>(i));
            XMLParser::SetNodeValue(doc, parentID, m_parentList[i]->GetID());
        }
    }
 
    auto electricalProp = XMLParser::AppendNode(doc, elementNode, "ElectricalProperties");
    auto isOnline = XMLParser::AppendNode(doc, electricalProp, "IsOnline");
    XMLParser::SetNodeValue(doc, isOnline, m_online);
    auto name = XMLParser::AppendNode(doc, electricalProp, "Name");
    XMLParser::SetNodeValue(doc, name, m_electricalData.name);
    auto nominalVoltage = XMLParser::AppendNode(doc, electricalProp, "NominalVoltage");
    XMLParser::SetNodeValue(doc, nominalVoltage, m_electricalData.nominalVoltage);
    XMLParser::SetNodeAttribute(doc, nominalVoltage, "UnitID", static_cast<int>(m_electricalData.nominalVoltageUnit));
    auto nominalPower = XMLParser::AppendNode(doc, electricalProp, "NominalPower");
    XMLParser::SetNodeValue(doc, nominalPower, m_electricalData.nominalPower);
    XMLParser::SetNodeAttribute(doc, nominalPower, "UnitID", static_cast<int>(m_electricalData.nominalPowerUnit));
    auto resistance = XMLParser::AppendNode(doc, electricalProp, "Resistance");
    XMLParser::SetNodeValue(doc, resistance, m_electricalData.resistance);
    XMLParser::SetNodeAttribute(doc, resistance, "UnitID", static_cast<int>(m_electricalData.resistanceUnit));
    auto indReactance = XMLParser::AppendNode(doc, electricalProp, "IndReactance");
    XMLParser::SetNodeValue(doc, indReactance, m_electricalData.indReactance);
    XMLParser::SetNodeAttribute(doc, indReactance, "UnitID", static_cast<int>(m_electricalData.indReactanceUnit));
    auto capSusceptance = XMLParser::AppendNode(doc, electricalProp, "CapSusceptance");
    XMLParser::SetNodeValue(doc, capSusceptance, m_electricalData.capSusceptance);
    XMLParser::SetNodeAttribute(doc, capSusceptance, "UnitID", static_cast<int>(m_electricalData.capSusceptanceUnit));
    auto lineSize = XMLParser::AppendNode(doc, electricalProp, "LineSize");
    XMLParser::SetNodeValue(doc, lineSize, m_electricalData.lineSize);
    auto useLinePower = XMLParser::AppendNode(doc, electricalProp, "UseLinePower");
    XMLParser::SetNodeValue(doc, useLinePower, m_electricalData.useLinePower);
 
    auto fault = XMLParser::AppendNode(doc, electricalProp, "Fault");
    auto zeroResistance = XMLParser::AppendNode(doc, fault, "ZeroResistance");
    XMLParser::SetNodeValue(doc, zeroResistance, m_electricalData.zeroResistance);
    auto zeroIndReactance = XMLParser::AppendNode(doc, fault, "ZeroIndReactance");
    XMLParser::SetNodeValue(doc, zeroIndReactance, m_electricalData.zeroIndReactance);
    auto zeroCapSusceptance = XMLParser::AppendNode(doc, fault, "ZeroCapSusceptance");
    XMLParser::SetNodeValue(doc, zeroCapSusceptance, m_electricalData.zeroCapSusceptance);
 
    SaveSwitchingData(doc, electricalProp);
 
    return elementNode;
}

◆ SetElectricalData()

virtual void Line::SetElectricalData ( LineElectricalData electricalData )

inlinevirtual

Definition at line 94 of file Line.h.

94{ m_electricalData = electricalData; }

◆ SetNodeParent()

bool Line::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 Branch.

Definition at line 536 of file Line.cpp.

{
    if (m_activeNodeID == 1 && parent == m_parentList[0]) return false;
    if (m_activeNodeID == 2 && parent == m_parentList[1]) return false;
 
    if (parent && m_activeNodeID != 0) {
        wxRect2DDouble nodeRect(0, 0, 0, 0);
        if (m_activeNodeID == 1) {
            nodeRect = wxRect2DDouble(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_activeNodeID == 2) {
            nodeRect = wxRect2DDouble(m_pointList[m_pointList.size() - 1].m_x - 5.0 - m_borderSize,
                m_pointList[m_pointList.size() - 1].m_y - 5.0 - m_borderSize,
                10 + 2.0 * m_borderSize, 10 + 2.0 * m_borderSize);
        }
 
        if (parent->Intersects(nodeRect)) {
            // If the line has no parents set the new rated voltage, otherwise check if it's not connecting
            // two different voltages buses
            Bus* parentBus = static_cast<Bus*>(parent);
            if (!m_parentList[0] && !m_parentList[1]) {
                m_electricalData.nominalVoltage = parentBus->GetElectricalData().nominalVoltage;
                m_electricalData.nominalVoltageUnit = parentBus->GetElectricalData().nominalVoltageUnit;
            }
            else if (m_electricalData.nominalVoltage != parentBus->GetElectricalData().nominalVoltage ||
                m_electricalData.nominalVoltageUnit != parentBus->GetElectricalData().nominalVoltageUnit) {
                wxMessageDialog msgDialog(nullptr,
                    _("Unable to connect two buses with different nominal voltages.\n"
                        "Use a transformer or edit the bus properties."),
                    _("Error"), wxOK | wxCENTRE | wxICON_ERROR);
                msgDialog.ShowModal();
                m_activeNodeID = 0;
                return false;
            }
 
            if (m_activeNodeID == 1) {
                // Check if the user is trying to connect the same bus.
                if (m_parentList[1] == parent) {
                    m_activeNodeID = 0;
                    return false;
                }
 
                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;
            }
            if (m_activeNodeID == 2) {
                if (m_parentList[0] == parent) {
                    m_activeNodeID = 0;
                    return false;
                }
 
                m_parentList[1] = parent;
 
                wxPoint2DDouble parentPt =
                    parent->RotateAtPosition(m_pointList[m_pointList.size() - 1], -parent->GetAngle());
                parentPt.m_y = parent->GetPosition().m_y;
                parentPt = parent->RotateAtPosition(parentPt, parent->GetAngle());
                m_pointList[m_pointList.size() - 1] = parentPt;
 
                UpdateSwitchesPosition();
                UpdatePowerFlowArrowsPosition();
                return true;
            }
        }
        else {
            if (m_activeNodeID == 1) m_parentList[0] = nullptr;
            if (m_activeNodeID == 2) m_parentList[1] = nullptr;
        }
    }
    return false;
}

Here is the call graph for this function:

◆ SetNominalVoltage()

void Line::SetNominalVoltage	(	std::vector< double >	nominalVoltage,
		std::vector< ElectricalUnit >	nominalVoltageUnit
	)

virtual

Set nominal voltage of the element.

Parameters

nominalVoltage	Value of the nominal voltage.
nominalVoltageUnit	Unit of the nominal voltage.

Reimplemented from PowerElement.

Definition at line 528 of file Line.cpp.

{
    if (nominalVoltage.size() > 0) {
        m_electricalData.nominalVoltage = nominalVoltage[0];
        m_electricalData.nominalVoltageUnit = nominalVoltageUnit[0];
    }
}

◆ SetPointList()

void Line::SetPointList ( std::vector< wxPoint2DDouble > pointList )

virtual

Set the list of points that connect the element to the bus.

Parameters

pointList List of points.

Reimplemented from Element.

Definition at line 659 of file Line.cpp.

{
    m_pointList = pointList;
    UpdateSwitchesPosition();
    UpdatePowerFlowArrowsPosition();
}

◆ SetPowerFlowDirection()

void Line::SetPowerFlowDirection ( PowerFlowDirection pfDirection )

virtual

Set the direction of the power flow.

Parameters

pfDirection Power flow direction.

Reimplemented from PowerElement.

Definition at line 619 of file Line.cpp.

{
    m_pfDirection = pfDirection;
    UpdatePowerFlowArrowsPosition();
}

Here is the caller graph for this function:

◆ ShowForm()

bool Line::ShowForm	(	wxWindow *	parent,
		Element *	element
	)

virtual

Show element data form.

Parameters

parent	Form parent
element	Element that will be edited.

Returns: True if the form is shown, false otherwise.

Reimplemented from Element.

Definition at line 518 of file Line.cpp.

{
    LineForm lineForm(parent, this);
    lineForm.CenterOnParent();
    if (lineForm.ShowModal() == wxID_OK) {
        return true;
    }
    return false;
}

◆ StartMove()

void Line::StartMove ( wxPoint2DDouble position )

virtual

Update the element attributes related to the movement.

Parameters

position Start move position.

Reimplemented from Branch.

Definition at line 378 of file Line.cpp.

{
    m_moveStartPt = position;
    m_movePts = m_pointList;
}

◆ UpdatePowerFlowArrowsPosition()

void Line::UpdatePowerFlowArrowsPosition ( )

protected

Definition at line 625 of file Line.cpp.

{
    std::vector<wxPoint2DDouble> edges;
    switch (m_pfDirection) {
    case PowerFlowDirection::PF_NONE: {
        m_powerFlowArrow.clear();
    } break;
    case PowerFlowDirection::PF_BUS1_TO_BUS2: {
        for (int i = 1; i < (int)m_pointList.size() - 1; i++) { edges.push_back(m_pointList[i]); }
    } break;
    case PowerFlowDirection::PF_BUS2_TO_BUS1: {
        for (int i = (int)m_pointList.size() - 2; i > 0; i--) { edges.push_back(m_pointList[i]); }
    } break;
    default:
        break;
    }
    CalculatePowerFlowPts(edges);
}

Member Data Documentation

◆ m_electricalData

LineElectricalData Line::m_electricalData

protected

Definition at line 103 of file Line.h.

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

Project/elements/powerElement/Line.h
Project/elements/powerElement/Line.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Line() [1/2]

◆ Line() [2/2]

◆ ~Line()

Member Function Documentation

◆ AddNode()

◆ AddParent()

◆ AddPoint()

◆ CalculateBoundaries()

◆ Contains()

◆ DrawDC() [1/2]

◆ DrawDC() [2/2]

◆ GetBestPickboxCursor()

◆ GetContextMenu()

◆ GetCopy()

◆ GetElectricalData()

◆ GetPUElectricalData()

◆ GetTipText()

◆ Intersects()

◆ Move()

◆ MoveNode()

◆ MovePickbox()

◆ OpenElement()

◆ PickboxContains()

◆ RemoveNode()

◆ RotateNode()

◆ SaveElement()

◆ SetElectricalData()

◆ SetNodeParent()

◆ SetNominalVoltage()

◆ SetPointList()

◆ SetPowerFlowDirection()

◆ ShowForm()

◆ StartMove()

◆ UpdatePowerFlowArrowsPosition()

Member Data Documentation

◆ m_electricalData