Files
qelectrotech-source-mirror/sources/TerminalStrip/realterminal.h
T
Kellermorph 29a8f018f4 Name where a cable goes at the end of a strip
The strip graphic fanned the wires out again after the cable, which
shows each core leaving the cable but says nothing about where it is
going -- the far end was unnamed. Keep the bundle together at the end
now: a short stub and a box with the Installation, Location and Label
(BMK) of the piece the cable lands on, the same three fields the cable
list computes for a target (cablelistrows.cpp), so the strip and the
list can never disagree.

The target is the first piece past the strip's own terminals the
wires of the cable land on, in plan order; a report is no arrival
(the cable continues on the linked sheet), several cores on one
piece are one landing, and a cable which lands on nothing but the
strip itself gets no box. The lines shrink to the end zone the
Terminal plan settings give (Cable end length), so the box never
grows past the strip the bounding rect reserved.

RealTerminal::cableTarget() works the whole out: the cable is the one
the wires drawn to the terminal carry, a name typed by hand is
looked up among the cables of the project, and the box is drawn for
the first wire of the cable group. tst_cabletarget checks the value
rule (own strip no target, spare no target, no cable no target) and
that painting with and without a target gives two different
pictures.
2026-10-19 21:43:27 +02:00

130 lines
4.3 KiB
C++

/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef REALTERMINAL_H
#define REALTERMINAL_H
#include <QSharedPointer>
#include <QColor>
#include <QDomElement>
#include <QUuid>
#include "../properties/elementdata.h"
class TerminalStrip;
class Element;
class TerminalElement;
class PhysicalTerminal;
class TerminalStripBridge;
/**
* @brief The RealTerminal class
* Represent a real terminal.
* A real terminal can be a drawn terminal in a folio
* or a terminal set by user but not present
* on any folio (for example a reserved terminal).
*
* When create a new instance of RealTerminal you must
* call sharedRef() and only use the returned QSharedPointer
* instead of the raw pointer
*/
class RealTerminal
{
friend class TerminalElement;
friend class PhysicalTerminal;
private:
RealTerminal(Element *element);
QSharedPointer<RealTerminal> sharedRef();
QSharedPointer<RealTerminal> sharedRef() const;
QWeakPointer<RealTerminal> weakRef();
void setPhysicalTerminal(const QSharedPointer<PhysicalTerminal> &phy_t);
public:
~RealTerminal();
static QSharedPointer<RealTerminal> createSpare(const ElementData &data, const QUuid &uuid = QUuid());
static QSharedPointer<RealTerminal> spareFromXml(const QDomElement &xml_element);
bool isSpare() const;
ElementData spareData() const;
void setSpareData(const ElementData &data);
ElementData terminalData() const;
TerminalStrip *parentStrip() const noexcept;
QSharedPointer<PhysicalTerminal> physicalTerminal() const noexcept;
QDomElement toXml(QDomDocument &parent_document) const;
int level() const;
QString label() const;
QString Xref() const;
QString cable() const;
QString cableWire() const;
bool isShield() const;
QVector<QString> cableTarget() const;
QColor color() const;
QColor stripeColor() const;
qreal section() const;
qreal widthMm() const;
QString catalogEntry() const;
bool hasSeparatorAfter() const;
//Keys used to store the cable data in the element informations
static QString cableInfoKey() { return QStringLiteral("terminal_cable"); }
static QString cableWireInfoKey() { return QStringLiteral("terminal_cable_wire"); }
static QString shieldInfoKey() { return QStringLiteral("terminal_shield"); }
//Keys used to store the color and the section (mm2) of the terminal
static QString colorInfoKey() { return QStringLiteral("terminal_color"); }
static QString sectionInfoKey() { return QStringLiteral("terminal_section"); }
//Key used to store the width (mm) of the terminal, drawn in the terminal strip
static QString widthInfoKey() { return QStringLiteral("terminal_width"); }
//Key used to store the terminal chosen in the catalog (TerminalCatalog::WidthEntry::label)
static QString catalogEntryInfoKey() { return QStringLiteral("terminal_catalog_entry"); }
//Key used to store if a separator plate is mounted after the terminal
static QString separatorInfoKey() { return QStringLiteral("terminal_separator"); }
static void applyCatalogEntry(DiagramContext &informations, const QString &entry_label);
QString conductor() const;
ElementData::TerminalType type() const;
ElementData::TerminalFunction function() const;
bool isLed() const;
bool isElement() const;
bool isBridged() const;
QSharedPointer<TerminalStripBridge> bridge() const;
Element* element() const;
QUuid elementUuid() const;
static QString xmlTagName();
private :
bool hasData() const;
QPointer<Element> m_element;
//A spare terminal has no element : it is on no folio, its data are its own
bool m_spare = false;
QUuid m_spare_uuid;
ElementData m_spare_data;
QWeakPointer<RealTerminal> m_this_weak;
QSharedPointer<PhysicalTerminal> m_physical_terminal;
};
#endif // REALTERMINAL_H