XWsfSeaTraffic::Vehicle Class Reference

#include <XWsfSeaTraffic.hpp>

Public Member Functions
	Vehicle ()
	Vehicle (WsfStringId aTypeId)
	~Vehicle ()
bool	ProcessInput (UtInput &aInput)
bool	Initialize (XWsfSeaTraffic &aSeaTraffic)
bool	operator== (const Vehicle &aRhs) const

Public Attributes
WsfStringId	mTypeId
int	mCount
double	mFraction
double	mLoiterTime
double	mDefaultLoiterTime
double	mSigmaLoiterTime
double	mSpeed
double	mDefaultSpeed
double	mSigmaSpeed
std::vector< WsfStringId >	mRouteIds

Detailed Description

Nested Class Defines a type of Vehicle.

Constructor & Destructor Documentation

Vehicle() [1/2]

XWsfSeaTraffic::Vehicle::Vehicle ( )

inline

Referenced by operator==().

Vehicle() [2/2]

XWsfSeaTraffic::Vehicle::Vehicle ( WsfStringId aTypeId )

inline

References mCount, mDefaultLoiterTime, mDefaultSpeed, mFraction, mLoiterTime, mSigmaLoiterTime, mSigmaSpeed, mSpeed, and mTypeId.

~Vehicle()

XWsfSeaTraffic::Vehicle::~Vehicle ( )

inline

Member Function Documentation

Initialize()

bool XWsfSeaTraffic::Vehicle::Initialize

(

XWsfSeaTraffic &

aSeaTraffic

)

Verifies any data that can't be verified during the ProcessInput phase. Returns true if successful. aSeaTraffic: The sea traffic simulation.

References WsfRouteTypes::Get(), WsfSimulationExtension::GetScenario(), mDefaultLoiterTime, mDefaultSpeed, mFraction, mLoiterTime, mRouteIds, mSpeed, mTypeId, and XWsfSeaTraffic::XWsfSeaTraffic().

operator==()

bool XWsfSeaTraffic::Vehicle::operator== ( const Vehicle & aRhs ) const

inline

References mTypeId, and Vehicle().

ProcessInput()

bool XWsfSeaTraffic::Vehicle::ProcessInput

(

UtInput &

aInput

)

Parses the ship ... end_ship block. Returns true if successful. Throws an input exception if an error is encountered. aInput: The input object.

References mFraction, mLoiterTime, mRouteIds, mSigmaLoiterTime, mSigmaSpeed, and mSpeed.

Member Data Documentation

mCount

int XWsfSeaTraffic::Vehicle::mCount

Referenced by Vehicle().

mDefaultLoiterTime

double XWsfSeaTraffic::Vehicle::mDefaultLoiterTime

Referenced by Initialize(), and Vehicle().

mDefaultSpeed

double XWsfSeaTraffic::Vehicle::mDefaultSpeed

Referenced by Initialize(), and Vehicle().

mFraction

double XWsfSeaTraffic::Vehicle::mFraction

Referenced by Initialize(), ProcessInput(), and Vehicle().

mLoiterTime

double XWsfSeaTraffic::Vehicle::mLoiterTime

Referenced by Initialize(), ProcessInput(), and Vehicle().

mRouteIds

std::vector<WsfStringId> XWsfSeaTraffic::Vehicle::mRouteIds

Referenced by Initialize(), and ProcessInput().

mSigmaLoiterTime

double XWsfSeaTraffic::Vehicle::mSigmaLoiterTime

Referenced by ProcessInput(), and Vehicle().

mSigmaSpeed

double XWsfSeaTraffic::Vehicle::mSigmaSpeed

Referenced by ProcessInput(), and Vehicle().

mSpeed

double XWsfSeaTraffic::Vehicle::mSpeed

Referenced by Initialize(), ProcessInput(), and Vehicle().

mTypeId

WsfStringId XWsfSeaTraffic::Vehicle::mTypeId

Referenced by Initialize(), operator==(), and Vehicle().

---

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

• XWsfSeaTraffic.hpp
• XWsfSeaTraffic.cpp