XWsfSeaTraffic::SeaLane Class Reference

#include <XWsfSeaTraffic.hpp>

Public Member Functions
	SeaLane ()
	SeaLane (WsfStringId aNameId)
	~SeaLane ()
bool	ProcessInput (UtInput &aInput)
bool	Initialize (XWsfSeaTraffic &aSeaTraffic)
WsfStringId	GetDestinationPort (WsfStringId aPortId) const
bool	IgnorePortRoute (WsfStringId aPortId) const
bool	operator== (const SeaLane &aRhs) const

Public Attributes
WsfStringId	mNameId
int	mPortCount
WsfStringId	mPortId [2]
bool	mPortIgnoreRoute [2]
std::vector< SeaRegion >	mLaneRoute

Detailed Description

Nested Class Defines a sea lane by two ports, which define the endpoints and optionally an intermediate path connecting the two endpoints.

Constructor & Destructor Documentation

SeaLane() [1/2]

XWsfSeaTraffic::SeaLane::SeaLane ( )

inline

Referenced by operator==().

SeaLane() [2/2]

XWsfSeaTraffic::SeaLane::SeaLane ( WsfStringId aNameId )

inline

References mNameId, mPortCount, mPortId, and mPortIgnoreRoute.

~SeaLane()

XWsfSeaTraffic::SeaLane::~SeaLane ( )

inline

Member Function Documentation

GetDestinationPort()

WsfStringId XWsfSeaTraffic::SeaLane::GetDestinationPort ( WsfStringId aPortId ) const

inline

Returns the destination port's string id. aPortId: The origination port's string id.

References mPortId.

Referenced by XWsfSeaTraffic::SeaPort::Initialize().

IgnorePortRoute()

bool XWsfSeaTraffic::SeaLane::IgnorePortRoute ( WsfStringId aPortId ) const

inline

Returns true if we should ignore the port route. aPortId: The port's string id.

References mPortId, and mPortIgnoreRoute.

Initialize()

bool XWsfSeaTraffic::SeaLane::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 XWsfSeaTraffic::DoesPortExist(), mPortCount, mPortId, and XWsfSeaTraffic::XWsfSeaTraffic().

operator==()

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

inline

References mNameId, and SeaLane().

ProcessInput()

bool XWsfSeaTraffic::SeaLane::ProcessInput

(

UtInput &

aInput

)

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

References mLaneRoute, mPortCount, mPortId, and mPortIgnoreRoute.

Member Data Documentation

mLaneRoute

std::vector<SeaRegion> XWsfSeaTraffic::SeaLane::mLaneRoute

Referenced by ProcessInput().

mNameId

WsfStringId XWsfSeaTraffic::SeaLane::mNameId

Referenced by operator==(), and SeaLane().

mPortCount

int XWsfSeaTraffic::SeaLane::mPortCount

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

mPortId

WsfStringId XWsfSeaTraffic::SeaLane::mPortId[2]

Referenced by GetDestinationPort(), IgnorePortRoute(), Initialize(), ProcessInput(), and SeaLane().

mPortIgnoreRoute

bool XWsfSeaTraffic::SeaLane::mPortIgnoreRoute[2]

Referenced by IgnorePortRoute(), ProcessInput(), and SeaLane().

---

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

• XWsfSeaTraffic.hpp
• XWsfSeaTraffic.cpp