Eclipse SUMO - Simulation of Urban MObility
GNETractionSubstation.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3// Copyright (C) 2021-2022 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
18//
19/****************************************************************************/
20#pragma once
21#include <config.h>
22
23#include "GNEAdditional.h"
24
25// ===========================================================================
26// class definitions
27// ===========================================================================
28
30
31public:
34
43 GNETractionSubstation(const std::string& id, GNENet* net, const Position& pos, const double voltage,
44 const double currentLimit, const Parameterised::Map& parameters);
45
48
52 void writeAdditional(OutputDevice& device) const;
53
58
62 void updateGeometry();
63
66
68 void updateCenteringBoundary(const bool updateGrid);
69
71 void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
73
78 std::string getParentName() const;
79
84 void drawGL(const GUIVisualizationSettings& s) const;
86
89 /* @brief method for getting the Attribute of an XML key
90 * @param[in] key The attribute key
91 * @return string with the value associated to key
92 */
93 std::string getAttribute(SumoXMLAttr key) const;
94
95 /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
96 * @param[in] key The attribute key
97 * @return double with the value associated to key
98 */
99 double getAttributeDouble(SumoXMLAttr key) const;
100
103
104 /* @brief method for setting the attribute and letting the object perform additional changes
105 * @param[in] key The attribute key
106 * @param[in] value The new value
107 * @param[in] undoList The undoList on which to register changes
108 */
109 void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
110
111 /* @brief method for checking if the key and their correspond attribute are valids
112 * @param[in] key The attribute key
113 * @param[in] value The value associated to key key
114 * @return true if the value is valid, false in other case
115 */
116 bool isValid(SumoXMLAttr key, const std::string& value);
117
119 std::string getPopUpID() const;
120
122 std::string getHierarchyName() const;
124
125protected:
128
130 double myVoltage;
131
134
135private:
137 void setAttribute(SumoXMLAttr key, const std::string& value);
138
140 void setMoveShape(const GNEMoveResult& moveResult);
141
143 void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
144
147
150};
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
An Element which don't belong to GNENet but has influence in the simulation.
Definition: GNEAdditional.h:48
move operation
move result
A NBNetBuilder extended by visualisation and editing capabilities.
Definition: GNENet.h:42
std::string getAttribute(SumoXMLAttr key) const
Position getPositionInView() const
Returns position of additional in view.
Position myPosition
position of tractionSubstation in view
void splitEdgeGeometry(const double splitPosition, const GNENetworkElement *originalElement, const GNENetworkElement *newElement, GNEUndoList *undoList)
split geometry
void writeAdditional(OutputDevice &device) const
write additional element into a xml file
void updateGeometry()
update pre-computed geometry information
std::string getParentName() const
Returns the name of the parent object (if any)
void drawGL(const GUIVisualizationSettings &s) const
Draws the object.
double getAttributeDouble(SumoXMLAttr key) const
double myCurrentLimit
current limit
void commitMoveShape(const GNEMoveResult &moveResult, GNEUndoList *undoList)
commit move shape
void setMoveShape(const GNEMoveResult &moveResult)
set move shape
std::string getHierarchyName() const
get Hierarchy Name (Used in AC Hierarchy)
GNETractionSubstation(const GNETractionSubstation &)=delete
Invalidated copy constructor.
std::string getPopUpID() const
get PopPup ID (Used in AC Hierarchy)
const Parameterised::Map & getACParametersMap() const
get parameters map
void setAttribute(SumoXMLAttr key, const std::string &value, GNEUndoList *undoList)
method for setting the attribute and letting the object perform additional changes
void updateCenteringBoundary(const bool updateGrid)
update centering boundary (implies change in RTREE)
GNETractionSubstation(GNENet *net)
default Constructor
GNEMoveOperation * getMoveOperation()
get move operation
bool isValid(SumoXMLAttr key, const std::string &value)
method for checking if the key and their correspondent attribute are valids
GNETractionSubstation & operator=(const GNETractionSubstation &)=delete
Invalidated assignment operator.
Stores the information about how to visualize structures.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
An upper class for objects with additional parameters.
Definition: Parameterised.h:41
std::map< std::string, std::string > Map
parameters map
Definition: Parameterised.h:45
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37