KPublicTransport::Vehicle
#include <vehicle.h>
Properties | |
Direction | direction |
QString | name |
float | platformPositionBegin |
float | platformPositionEnd |
QVariantList | sections |
Public Member Functions | |
bool | hasPlatformPositions () const |
bool | hasPlatformSectionNames () const |
bool | isEmpty () const |
float | platformPositionBegin () const |
float | platformPositionEnd () const |
Q_INVOKABLE float | platformPositionForSection (const QString §ionName) const |
const std::vector< VehicleSection > & | sections () const |
void | setSections (const std::vector< VehicleSection > §ions) |
void | setSections (std::vector< VehicleSection > &§ions) |
std::vector< VehicleSection > && | takeSections () |
Static Public Member Functions | |
static std::vector< Vehicle > | fromJson (const QJsonArray &array) |
static Vehicle | fromJson (const QJsonObject &obj) |
static Vehicle | merge (const Vehicle &lhs, const Vehicle &rhs) |
static QJsonArray | toJson (const std::vector< Vehicle > &vehicles) |
static QJsonObject | toJson (const Vehicle &vehicle) |
Detailed Description
Information about the vehicle used on a journey.
This is typically only available for trains, and describes their coach layout.
A vehicle object always is tied to a specific Platform object, to which all positions refer to.
- See also
- Platform
Property Documentation
◆ direction
|
readwrite |
◆ name
|
readwrite |
◆ platformPositionBegin
|
read |
◆ platformPositionEnd
|
read |
◆ sections
|
read |
Member Function Documentation
◆ fromJson() [1/2]
|
static |
Deserialize multiple objects from JSON.
Definition at line 225 of file vehicle.cpp.
◆ fromJson() [2/2]
|
static |
Deserialize an object from JSON.
Definition at line 218 of file vehicle.cpp.
◆ hasPlatformPositions()
bool Vehicle::hasPlatformPositions | ( | ) | const |
Checks whether all vehicle sections have platform positions set.
Definition at line 230 of file vehicle.cpp.
◆ hasPlatformSectionNames()
bool Vehicle::hasPlatformSectionNames | ( | ) | const |
Check whether all vehicle sections have platform section names set.
Definition at line 235 of file vehicle.cpp.
◆ isEmpty()
bool Vehicle::isEmpty | ( | ) | const |
Returns true
if this object contains no information beyond the default values.
Definition at line 118 of file vehicle.cpp.
◆ merge()
Merge two Vehicle instances.
Definition at line 182 of file vehicle.cpp.
◆ platformPositionBegin()
float Vehicle::platformPositionBegin | ( | ) | const |
Definition at line 154 of file vehicle.cpp.
◆ platformPositionEnd()
float Vehicle::platformPositionEnd | ( | ) | const |
Definition at line 163 of file vehicle.cpp.
◆ platformPositionForSection()
float Vehicle::platformPositionForSection | ( | const QString & | sectionName | ) | const |
Returns the center position of the vehicle section named sectionName
in relative platform coordinates.
Useful for centering a view on a selected section for example.
Definition at line 172 of file vehicle.cpp.
◆ sections()
const std::vector< VehicleSection > & Vehicle::sections | ( | ) | const |
The vehicle sections.
Definition at line 123 of file vehicle.cpp.
◆ setSections() [1/2]
void Vehicle::setSections | ( | const std::vector< VehicleSection > & | sections | ) |
Definition at line 140 of file vehicle.cpp.
◆ setSections() [2/2]
void Vehicle::setSections | ( | std::vector< VehicleSection > && | sections | ) |
Sets the vehicle sections.
Definition at line 134 of file vehicle.cpp.
◆ takeSections()
std::vector< VehicleSection > && Vehicle::takeSections | ( | ) |
Moves the vehicle sections out of this object.
Definition at line 128 of file vehicle.cpp.
◆ toJson() [1/2]
|
static |
Serializes multiple vehicle objects to JSON.
Definition at line 213 of file vehicle.cpp.
◆ toJson() [2/2]
|
static |
Serializes one vehicle object to JSON.
Definition at line 204 of file vehicle.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:06 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.