Abstract class of power elements. More...

#include <PowerElement.h>

Inheritance diagram for PowerElement:

[legend]

Collaboration diagram for PowerElement:

[legend]

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

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

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

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.

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

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

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

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

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

void	SetParent (Element *parent, int num)

void	SetChild (Element *child, int num)

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	RemoveParent (Element *parent)
	Remove a parent.

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

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

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	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	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 Attributes
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

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

Abstract class of power elements.

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

Date: 18/01/2017

Definition at line 95 of file PowerElement.h.

Constructor & Destructor Documentation

◆ PowerElement()

PowerElement::PowerElement ( )

Constructor.

Definition at line 24 of file PowerElement.cpp.

                           : Element()
{
    m_busColour.Set(0, 78, 255, 255);
    m_onlineElementColour.Set(51, 51, 51, 255);
    m_offlineElementColour.Set(128, 128, 128, 255);
    m_closedSwitchColour.Set(0, 102, 0, 255);
    m_openedSwitchColour.Set(255, 26, 26, 255);
    m_powerFlowArrowColour.Set(255, 130, 0, 255);
    m_dynamicEventColour.Set(255, 130, 0, 255);
}

◆ ~PowerElement()

virtual PowerElement::~PowerElement ( )

inlinevirtual

Destructor.

Definition at line 105 of file PowerElement.h.

105{}

Member Function Documentation

◆ CalculatePowerFlowPts()

void PowerElement::CalculatePowerFlowPts ( std::vector< wxPoint2DDouble > edges )

virtual

Calculate the points of the power flow arrows.

Parameters

edges Points of the element that arrows point.

Definition at line 161 of file PowerElement.cpp.

{
    double arrowRate = 100.0;  // One arrow to each "arrowRate" distance in pixels.
 
    if(edges.size() < 2) return;
 
    // Clear all power flow points
    for(int i = 0; i < (int)m_powerFlowArrow.size(); i++) m_powerFlowArrow[i].clear();
    m_powerFlowArrow.clear();
 
    for(int i = 1; i < (int)edges.size(); i++) {
        wxPoint2DDouble pt1 = edges[i - 1];
        wxPoint2DDouble pt2 = edges[i];
 
        double angle = std::atan2(pt2.m_y - pt1.m_y, pt2.m_x - pt1.m_x);
 
        wxPoint2DDouble rotPt2(
            std::cos(-angle) * (pt2.m_x - pt1.m_x) - std::sin(-angle) * (pt2.m_y - pt1.m_y) + pt1.m_x,
            std::sin(-angle) * (pt2.m_x - pt1.m_x) + std::cos(-angle) * (pt2.m_y - pt1.m_y) + pt1.m_y);
 
        int numArrows = std::abs(pt1.m_x - rotPt2.m_x) / arrowRate;
        if(numArrows == 0) numArrows = 1;
 
        for(int i = 0; i < numArrows; i++) {
            wxPoint2DDouble arrowCenter(pt1.m_x + ((rotPt2.m_x - pt1.m_x) / double(numArrows + 1)) * double(i + 1),
                                        pt1.m_y + ((rotPt2.m_y - pt1.m_y) / double(numArrows + 1)) * double(i + 1));
 
            std::vector<wxPoint2DDouble> triPts;
            triPts.push_back(arrowCenter + wxPoint2DDouble(5.0, 0.0));
            triPts.push_back(arrowCenter + wxPoint2DDouble(-5.0, 5.0));
            triPts.push_back(arrowCenter + wxPoint2DDouble(-5.0, -5.0));
 
            // Rotate back.
            for(int i = 0; i < 3; i++) {
                triPts[i] = wxPoint2DDouble(
                    std::cos(angle) * (triPts[i].m_x - pt1.m_x) - std::sin(angle) * (triPts[i].m_y - pt1.m_y) + pt1.m_x,
                    std::sin(angle) * (triPts[i].m_x - pt1.m_x) + std::cos(angle) * (triPts[i].m_y - pt1.m_y) +
                        pt1.m_y);
            }
            m_powerFlowArrow.push_back(triPts);
        }
    }
}

◆ DrawDCPowerFlowPts() [1/2]

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

virtual

Definition at line 222 of file PowerElement.cpp.

{
    dc.SetPen(*wxTRANSPARENT_PEN);
    if (m_online) {
        dc.SetBrush(wxBrush(guiColour->pfArrow));
        for (auto arrow : m_powerFlowArrow) { 
            std::vector<wxPoint> arrowPts;
            for (auto& pt : arrow) {
                arrowPts.emplace_back(static_cast<int>(pt.m_x), static_cast<int>(pt.m_y));
            }
            DrawDCTriangle(arrowPts, dc);
        }
    }
}

◆ DrawDCPowerFlowPts() [2/2]

void PowerElement::DrawDCPowerFlowPts	(	GUIColour *	guiColour,
		wxGraphicsContext *	gc
	)		const

virtual

Draw power flow arrows.

Draw power flow arrows using device context.

Parameters

gc	Device context.

Definition at line 213 of file PowerElement.cpp.

{
    gc->SetPen(*wxTRANSPARENT_PEN);
    if (m_online) {
        gc->SetBrush(wxBrush(guiColour->pfArrow));
        for (auto arrow : m_powerFlowArrow) { DrawDCTriangle(arrow, gc); }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawDCSwitches() [1/2]

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

virtual

Definition at line 140 of file PowerElement.cpp.

{
    dc.SetPen(*wxTRANSPARENT_PEN);
 
    int i = 0;
    for (auto parent : m_parentList) {
        if (parent) {
            if (m_online) {
                dc.SetBrush(wxBrush(guiColour->swClose));
            }
            else {
                dc.SetBrush(wxBrush(guiColour->swOpen));
            }
 
            DrawDCRectangle(m_switchRect[i].GetPosition() + wxPoint2DDouble(m_switchSize / 2.0, m_switchSize / 2.0),
                m_switchSize, m_switchSize, parent->GetAngle(), dc);
        }
        i++;
    }
}

◆ DrawDCSwitches() [2/2]

void PowerElement::DrawDCSwitches	(	GUIColour *	guiColour,
		wxGraphicsContext *	gc
	)		const

virtual

Draw switch.

Draw switch using device context.

Definition at line 110 of file PowerElement.cpp.

{
    gc->SetPen(*wxTRANSPARENT_PEN);
    
    int i = 0;
    for (auto parent : m_parentList) {
        if (parent) {
            if (m_online) {
                gc->SetBrush(wxBrush(guiColour->swClose));
            }
            else {
                gc->SetBrush(wxBrush(guiColour->swOpen));
            }
 
            gc->PushState();
            gc->Translate(m_switchRect[i].GetPosition().m_x + m_switchSize / 2.0,
                m_switchRect[i].GetPosition().m_y + m_switchSize / 2.0);
            gc->Rotate(wxDegToRad(parent->GetAngle()));
            gc->Translate(-m_switchRect[i].GetPosition().m_x - m_switchSize / 2.0,
                -m_switchRect[i].GetPosition().m_y - m_switchSize / 2.0);
 
            wxPoint2DDouble switchPos = m_switchRect[i].GetPosition();
            gc->DrawRectangle(switchPos.m_x, switchPos.m_y, m_switchSize, m_switchSize);
 
            gc->PopState();
        }
        i++;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlotData()

virtual bool PowerElement::GetPlotData	(	ElementPlotData &	plotData,
		PlotStudy	study = `PlotStudy::STABILITY`
	)

inlinevirtual

Fill the plot data.

Parameters

plotData Plot data to be filled.

Returns: true if the plot data was successfully filled, false otherwise.

Reimplemented in Bus, IndMotor, Load, and SyncGenerator.

Definition at line 191 of file PowerElement.h.

191{ return false; }

◆ GetPowerFlowDirection()

virtual PowerFlowDirection PowerElement::GetPowerFlowDirection ( ) const

inlinevirtual

Return the direction of the power flow.

Returns: Power flow direction.

Definition at line 185 of file PowerElement.h.

185{ return m_pfDirection; }

◆ GetSwitchingData()

virtual SwitchingData PowerElement::GetSwitchingData ( )

inlinevirtual

Returns the switching data of the element.

Returns: Element switching data.

Definition at line 175 of file PowerElement.h.

175{ return m_swData; }

◆ GetSwitchPoint()

wxPoint2DDouble PowerElement::GetSwitchPoint	(	Element *	parent,
		wxPoint2DDouble	parentPoint,
		wxPoint2DDouble	secondPoint
	)		const

virtual

Get the correct switch position.

Parameters

parent	Bus with switch.
parentPoint	Position of node on parent.
secondPoint	Next point in element.

Definition at line 39 of file PowerElement.cpp.

{
    double swLineSize = 25.0;
    wxPoint2DDouble swPoint = wxPoint2DDouble(parentPoint.m_x, parentPoint.m_y - swLineSize);
 
    // Rotate the second point (to compare).
    double angle = parent->GetAngle();
 
    secondPoint =
        wxPoint2DDouble(std::cos(wxDegToRad(-angle)) * (secondPoint.m_x - parentPoint.m_x) -
                            std::sin(wxDegToRad(-angle)) * (secondPoint.m_y - parentPoint.m_y) + parentPoint.m_x,
                        std::sin(wxDegToRad(-angle)) * (secondPoint.m_x - parentPoint.m_x) +
                            std::cos(wxDegToRad(-angle)) * (secondPoint.m_y - parentPoint.m_y) + parentPoint.m_y);
 
    // Rotate
    if(secondPoint.m_y > parentPoint.m_y) angle -= 180.0;
    return wxPoint2DDouble(std::cos(wxDegToRad(angle)) * (swPoint.m_x - parentPoint.m_x) -
                               std::sin(wxDegToRad(angle)) * (swPoint.m_y - parentPoint.m_y) + parentPoint.m_x,
                           std::sin(wxDegToRad(angle)) * (swPoint.m_x - parentPoint.m_x) +
                               std::cos(wxDegToRad(angle)) * (swPoint.m_y - parentPoint.m_y) + parentPoint.m_y);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetValueFromUnit()

double PowerElement::GetValueFromUnit	(	double	value,
		ElectricalUnit	valueUnit
	)		const

virtual

Definition at line 237 of file PowerElement.cpp.

{
    switch(valueUnit) {
        case ElectricalUnit::UNIT_kV:
        case ElectricalUnit::UNIT_kA:
        case ElectricalUnit::UNIT_kW:
        case ElectricalUnit::UNIT_kVA:
        case ElectricalUnit::UNIT_kvar: {
            return value * 1e3;
        } break;
        case ElectricalUnit::UNIT_MW:
        case ElectricalUnit::UNIT_MVA:
        case ElectricalUnit::UNIT_Mvar: {
            return value * 1e6;
        }
        default:
            break;
    }
    return value;
}

◆ HaveDynamicEvent()

virtual bool PowerElement::HaveDynamicEvent ( ) const

inlinevirtual

Check if the power element have dynamic event.

Returns: true if the element have dynamic an event, false otherwise.

Definition at line 196 of file PowerElement.h.

196{ return m_dynEvent; }

◆ OpenCADProperties()

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

virtual

Definition at line 258 of file PowerElement.cpp.

{
    auto cadPropNode = elementNode->first_node("CADProperties");
    if(!cadPropNode) return false;
 
    auto position = cadPropNode->first_node("Position");
    double posX = XMLParser::GetNodeValueDouble(position, "X");
    double posY = XMLParser::GetNodeValueDouble(position, "Y");
    auto size = cadPropNode->first_node("Size");
    m_width = XMLParser::GetNodeValueDouble(size, "Width");
    m_height = XMLParser::GetNodeValueDouble(size, "Height");
    double angle = XMLParser::GetNodeValueDouble(cadPropNode, "Angle");
    SetPosition(wxPoint2DDouble(posX, posY));
 
    auto nodePosition = cadPropNode->first_node("NodePosition");
    double nodePosX = XMLParser::GetNodeValueDouble(nodePosition, "X");
    double nodePosY = XMLParser::GetNodeValueDouble(nodePosition, "Y");
 
    int parentID = XMLParser::GetNodeValueInt(cadPropNode, "ParentID");
    // If the opened power element has no parent, set up the basics CAD properties of the element manually, otherwise
    // just class method AddParent to calculate properly.
    if(parentID == -1) {
        m_parentList.push_back(nullptr);
        m_pointList.push_back(wxPoint2DDouble(nodePosX, nodePosY));
        m_pointList.push_back(wxPoint2DDouble(nodePosX, nodePosY));
        m_pointList.push_back(m_position + wxPoint2DDouble(0.0, -m_height / 2.0 - 10.0));
        m_pointList.push_back(m_position + wxPoint2DDouble(0.0, -m_height / 2.0));
 
        wxRect2DDouble genRect(0, 0, 0, 0);
        m_switchRect.push_back(genRect);  // Push a general rectangle.
        UpdateSwitches();
 
        m_online = false;  // Not connected elements are always offline.
    } else {
        AddParent(parentList[parentID], wxPoint2DDouble(nodePosX, nodePosY));
    }
 
    // Set up the points properly.
    StartMove(m_position);
    Move(wxPoint2DDouble(posX, posY));
 
    // Set the rotation properly.
    int numRot = angle / m_rotationAngle;
    bool clockwise = true;
    if(numRot < 0) {
        numRot = std::abs(numRot);
        clockwise = false;
    }
    for(int i = 0; i < numRot; i++) Rotate(clockwise);
 
    return true;
}

◆ OpenElement()

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

inlinevirtual

Definition at line 206 of file PowerElement.h.

206{ return true; }

◆ OpenSwitchingData()

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

virtual

Definition at line 349 of file PowerElement.cpp.

{
    auto switchingList = electricalNode->first_node("SwitchingList");
    if(!switchingList) return false;
    auto swNode = switchingList->first_node("Switching");
    while(swNode) {
        m_swData.swType.push_back((SwitchingType)XMLParser::GetNodeValueInt(swNode, "Type"));
        m_swData.swTime.push_back(XMLParser::GetNodeValueDouble(swNode, "Time"));
        swNode = swNode->next_sibling("Switching");
    }
    return true;
}

◆ SaveCADProperties()

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

virtual

Definition at line 311 of file PowerElement.cpp.

{
    auto cadProp = XMLParser::AppendNode(doc, elementNode, "CADProperties");
    auto position = XMLParser::AppendNode(doc, cadProp, "Position");
    auto posX = XMLParser::AppendNode(doc, position, "X");
    XMLParser::SetNodeValue(doc, posX, m_position.m_x);
    auto posY = XMLParser::AppendNode(doc, position, "Y");
    XMLParser::SetNodeValue(doc, posY, m_position.m_y);
    auto size = XMLParser::AppendNode(doc, cadProp, "Size");
    auto width = XMLParser::AppendNode(doc, size, "Width");
    XMLParser::SetNodeValue(doc, width, m_width);
    auto height = XMLParser::AppendNode(doc, size, "Height");
    XMLParser::SetNodeValue(doc, height, m_height);
    auto angle = XMLParser::AppendNode(doc, cadProp, "Angle");
    XMLParser::SetNodeValue(doc, angle, m_angle);
    auto nodePos = XMLParser::AppendNode(doc, cadProp, "NodePosition");
    auto nodePosX = XMLParser::AppendNode(doc, nodePos, "X");
    XMLParser::SetNodeValue(doc, nodePosX, m_pointList[0].m_x);
    auto nodePosY = XMLParser::AppendNode(doc, nodePos, "Y");
    XMLParser::SetNodeValue(doc, nodePosY, m_pointList[0].m_y);
    auto parentID = XMLParser::AppendNode(doc, cadProp, "ParentID");
    Element* parent = m_parentList[0];
    if(parent) XMLParser::SetNodeValue(doc, parentID, parent->GetID());
}

◆ SaveSwitchingData()

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

virtual

Definition at line 336 of file PowerElement.cpp.

{
    auto switchingList = XMLParser::AppendNode(doc, electricalNode, "SwitchingList");
    for(int i = 0; i < static_cast<int>(m_swData.swType.size()); i++) {
        auto switching = XMLParser::AppendNode(doc, switchingList, "Switching");
        XMLParser::SetNodeAttribute(doc, switching, "ID", i);
        auto swType = XMLParser::AppendNode(doc, switching, "Type");
        XMLParser::SetNodeValue(doc, swType, static_cast<int>(m_swData.swType[i]));
        auto swTime = XMLParser::AppendNode(doc, switching, "Time");
        XMLParser::SetNodeValue(doc, swTime, m_swData.swTime[i]);
    }
}

◆ SetDynamicEvent()

virtual void PowerElement::SetDynamicEvent ( bool dynEvent = true )

inlinevirtual

Set if the power element have dynamic event.

Parameters

dynEvent Event occurrence.

Definition at line 201 of file PowerElement.h.

201{ m_dynEvent = dynEvent; }

◆ SetNominalVoltage()

void PowerElement::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 in EMTElement, Line, SyncGenerator, SyncMotor, and Transformer.

Definition at line 35 of file PowerElement.cpp.

36{

37}

◆ SetPowerFlowDirection()

virtual void PowerElement::SetPowerFlowDirection ( PowerFlowDirection pfDirection )

inlinevirtual

Set the direction of the power flow.

Parameters

pfDirection Power flow direction.

Reimplemented in Line, Machines, and Transformer.

Definition at line 180 of file PowerElement.h.

180{ m_pfDirection = pfDirection; }

Here is the caller graph for this function:

◆ SetSwitchingData()

virtual void PowerElement::SetSwitchingData ( SwitchingData data )

inlinevirtual

Set the switching data of the element.

Parameters

data	Switching data.

Definition at line 170 of file PowerElement.h.

170{ m_swData = data; }

◆ SwitchesContains()

bool PowerElement::SwitchesContains ( wxPoint2DDouble position ) const

virtual

Check if switch contains position.

Parameters

position position to be checked.

Definition at line 63 of file PowerElement.cpp.

{
    for(int i = 0; i < (int)m_switchRect.size(); i++) {
        if(m_parentList[i]) {
            if(m_switchRect[i].Contains(position)) return true;
        }
    }
    return false;
}

Here is the call graph for this function:

◆ UpdateSwitches()

void PowerElement::UpdateSwitches ( )

virtual

Update the switch position.

Reimplemented in Branch.

Definition at line 73 of file PowerElement.cpp.

{
    // General method, to one switch only.
    wxPoint2DDouble swCenter = wxPoint2DDouble((m_pointList[0].m_x + m_pointList[1].m_x) / 2.0,
                                               (m_pointList[0].m_y + m_pointList[1].m_y) / 2.0);
    m_switchRect[0] = wxRect2DDouble(swCenter.m_x - m_switchSize / 2.0, swCenter.m_y - m_switchSize / 2.0, m_switchSize,
                                     m_switchSize);
}

Here is the caller graph for this function:

Member Data Documentation

◆ m_busColour

wxColour PowerElement::m_busColour

protected

Definition at line 215 of file PowerElement.h.

◆ m_closedSwitchColour

wxColour PowerElement::m_closedSwitchColour

protected

Definition at line 218 of file PowerElement.h.

◆ m_dynamicEventColour

wxColour PowerElement::m_dynamicEventColour

protected

Definition at line 221 of file PowerElement.h.

◆ m_dynEvent

bool PowerElement::m_dynEvent = false

protected

Definition at line 223 of file PowerElement.h.

◆ m_offlineElementColour

wxColour PowerElement::m_offlineElementColour

protected

Definition at line 217 of file PowerElement.h.

◆ m_onlineElementColour

wxColour PowerElement::m_onlineElementColour

protected

Definition at line 216 of file PowerElement.h.

◆ m_openedSwitchColour

wxColour PowerElement::m_openedSwitchColour

protected

Definition at line 219 of file PowerElement.h.

◆ m_pfDirection

PowerFlowDirection PowerElement::m_pfDirection = PowerFlowDirection::PF_NONE

protected

Definition at line 213 of file PowerElement.h.

◆ m_powerFlowArrow

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

protected

Definition at line 212 of file PowerElement.h.

◆ m_powerFlowArrowColour

wxColour PowerElement::m_powerFlowArrowColour

protected

Definition at line 220 of file PowerElement.h.

◆ m_swData

SwitchingData PowerElement::m_swData

protected

Definition at line 211 of file PowerElement.h.

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

Project/elements/powerElement/PowerElement.h
Project/elements/powerElement/PowerElement.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PowerElement()

◆ ~PowerElement()

Member Function Documentation

◆ CalculatePowerFlowPts()

◆ DrawDCPowerFlowPts() [1/2]

◆ DrawDCPowerFlowPts() [2/2]

◆ DrawDCSwitches() [1/2]

◆ DrawDCSwitches() [2/2]

◆ GetPlotData()

◆ GetPowerFlowDirection()

◆ GetSwitchingData()

◆ GetSwitchPoint()

◆ GetValueFromUnit()

◆ HaveDynamicEvent()

◆ OpenCADProperties()

◆ OpenElement()

◆ OpenSwitchingData()

◆ SaveCADProperties()

◆ SaveSwitchingData()

◆ SetDynamicEvent()

◆ SetNominalVoltage()

◆ SetPowerFlowDirection()

◆ SetSwitchingData()

◆ SwitchesContains()

◆ UpdateSwitches()

Member Data Documentation

◆ m_busColour

◆ m_closedSwitchColour

◆ m_dynamicEventColour

◆ m_dynEvent

◆ m_offlineElementColour

◆ m_onlineElementColour

◆ m_openedSwitchColour

◆ m_pfDirection

◆ m_powerFlowArrow

◆ m_powerFlowArrowColour

◆ m_swData