WSF
XWsfRoadTraffic::RoadTrafficNetworkInput Class Reference

#include <XWsfRoadTraffic.hpp>

Inheritance diagram for XWsfRoadTraffic::RoadTrafficNetworkInput:
Collaboration diagram for XWsfRoadTraffic::RoadTrafficNetworkInput:

Public Member Functions

 RoadTrafficNetworkInput ()=default
 RoadTrafficNetworkInput (WsfStringId aNetworkId)
NetworkInputClone () const noexcept override
void VerifyData (UtInput &aInput) override
Public Member Functions inherited from XWsfRouteNetwork::NetworkInput
 NetworkInput (WsfStringId aNetworkId)
virtual ~NetworkInput ()=default
virtual bool Initialize ()

Public Attributes

double mMinDistOffRoad = 0.0
double mMaxDistOffRoad = 0.0
 Minimum distance vehicle travels off road (meters).
double mPauseTime = 0.0
 Maximum distance vehicle travels off road (meters).
double mMaxSpeed = 0.0
 Pause time after completing travel (seconds).
double mMeanTravelTime = 0.0
 Maximum speed of any vehicle (m/s).
double mSigmaTravelTime = 0.0
 Mean travel time of vehicles (s).
double mTotalDist = 0.0
 Sigma travel time of vehicles (s).
std::vector< VehicleInputmVehicleInput
 The sum of the lengths of all the roads (meters).
std::vector< WeightedRegionInputmWeightedRegionInput
 Data for each of the vehicle types on this road network.
std::vector< WeightedRouteSegmentmWeightedRouteSegments
 Data for each of the weighted regions in this road network.
std::vector< ConvoyInputmConvoyInput
Public Attributes inherited from XWsfRouteNetwork::NetworkInput
WsfRouteNetworkmRouteNetworkPtr
WsfStringId mNetworkId
int mVehicleCount
double mVehicleDensity

Protected Member Functions

 RoadTrafficNetworkInput (const RoadTrafficNetworkInput &aSrc)=default
 Data for each of the convoys in this road network.
Protected Member Functions inherited from XWsfRouteNetwork::NetworkInput
 NetworkInput (const NetworkInput &aRhs)=default

Detailed Description

A NetworkInput object is created for each network defined in the input file. It holds data that is relevant to anything in its network, such as roads and vehicles.

Constructor & Destructor Documentation

◆ RoadTrafficNetworkInput() [1/3]

XWsfRoadTraffic::RoadTrafficNetworkInput::RoadTrafficNetworkInput ( )
default

Referenced by Clone(), and RoadTrafficNetworkInput().

◆ RoadTrafficNetworkInput() [2/3]

XWsfRoadTraffic::RoadTrafficNetworkInput::RoadTrafficNetworkInput ( WsfStringId aNetworkId)
inline

◆ RoadTrafficNetworkInput() [3/3]

XWsfRoadTraffic::RoadTrafficNetworkInput::RoadTrafficNetworkInput ( const RoadTrafficNetworkInput & aSrc)
protecteddefault

Data for each of the convoys in this road network.

References RoadTrafficNetworkInput().

Member Function Documentation

◆ Clone()

NetworkInput * XWsfRoadTraffic::RoadTrafficNetworkInput::Clone ( ) const
inlineoverridevirtualnoexcept

◆ VerifyData()

void XWsfRoadTraffic::RoadTrafficNetworkInput::VerifyData ( UtInput & aInput)
inlineoverridevirtual

Reimplemented from XWsfRouteNetwork::NetworkInput.

References mVehicleInput.

Member Data Documentation

◆ mConvoyInput

std::vector<ConvoyInput> XWsfRoadTraffic::RoadTrafficNetworkInput::mConvoyInput

◆ mMaxDistOffRoad

double XWsfRoadTraffic::RoadTrafficNetworkInput::mMaxDistOffRoad = 0.0

Minimum distance vehicle travels off road (meters).

◆ mMaxSpeed

double XWsfRoadTraffic::RoadTrafficNetworkInput::mMaxSpeed = 0.0

Pause time after completing travel (seconds).

◆ mMeanTravelTime

double XWsfRoadTraffic::RoadTrafficNetworkInput::mMeanTravelTime = 0.0

Maximum speed of any vehicle (m/s).

◆ mMinDistOffRoad

double XWsfRoadTraffic::RoadTrafficNetworkInput::mMinDistOffRoad = 0.0

◆ mPauseTime

double XWsfRoadTraffic::RoadTrafficNetworkInput::mPauseTime = 0.0

Maximum distance vehicle travels off road (meters).

◆ mSigmaTravelTime

double XWsfRoadTraffic::RoadTrafficNetworkInput::mSigmaTravelTime = 0.0

Mean travel time of vehicles (s).

◆ mTotalDist

double XWsfRoadTraffic::RoadTrafficNetworkInput::mTotalDist = 0.0

Sigma travel time of vehicles (s).

◆ mVehicleInput

std::vector<VehicleInput> XWsfRoadTraffic::RoadTrafficNetworkInput::mVehicleInput

The sum of the lengths of all the roads (meters).

Referenced by VerifyData().

◆ mWeightedRegionInput

std::vector<WeightedRegionInput> XWsfRoadTraffic::RoadTrafficNetworkInput::mWeightedRegionInput

Data for each of the vehicle types on this road network.

◆ mWeightedRouteSegments

std::vector<WeightedRouteSegment> XWsfRoadTraffic::RoadTrafficNetworkInput::mWeightedRouteSegments

Data for each of the weighted regions in this road network.

A list of weighted segments used to place bodies on the road network, with higher densities favoring larger edge weights.

Referenced by XWsfRoadTraffic::Initialize().


The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved