DtRailObstructionInfo Class Reference

Set of data, used in conjunction with a DtCollision, to specify the information about an obstruction along a rail. More...

List of all members.

Public Member Functions
	DtRailObstructionInfo ()
virtual	~DtRailObstructionInfo ()
virtual void	adjustDistances (double adjustmentValue)
	Adds the adjustmentValue to each distance in this info.
virtual void	merge (const DtRailObstructionInfo &source)
	Changes the data of this class to encompass the data in source.
virtual std::set< int > &	lanes ()
	The lanes obstructed by this obstruction.
virtual const std::set< int > &	lanes () const
	The lanes obstructed by this obstruction.
virtual double	startBlockDistance () const
	The distance along the rail to the point where the obstruction starts blocking the rail.
virtual void	setStartBlockDistance (double v)
	The distance along the rail to the point where the obstruction starts blocking the rail.
virtual double	endBlockDistance () const
	The distance along the rail until this obstruction is clear.
virtual void	setEndBlockDistance (double v)
	The distance along the rail until this obstruction is clear.
virtual double	velocityAlongSegment () const
	The aspect of velocity of the obstruction that is along the direction of the segment.
virtual void	setVelocityAlongSegment (double v)
	The aspect of velocity of the obstruction that is along the direction of the segment.
Protected Attributes
std::set< int >	myLanes
double	myStartBlockDistance
double	myEndBlockDistance
double	myVelocityAlongSegment

---

Detailed Description

Set of data, used in conjunction with a DtCollision, to specify the information about an obstruction along a rail.

Information is in an entity centric format.

---

Constructor & Destructor Documentation

DtRailObstructionInfo::DtRailObstructionInfo

(

)

virtual DtRailObstructionInfo::~DtRailObstructionInfo

(

)

[virtual]

---

Member Function Documentation

virtual std::set<int>& DtRailObstructionInfo::lanes

(

)

[virtual]

The lanes obstructed by this obstruction.

virtual const std::set<int>& DtRailObstructionInfo::lanes

(

)

const [virtual]

The lanes obstructed by this obstruction.

virtual double DtRailObstructionInfo::startBlockDistance

(

)

const [virtual]

The distance along the rail to the point where the obstruction starts blocking the rail.

virtual void DtRailObstructionInfo::setStartBlockDistance

(

double

v

)

[virtual]

The distance along the rail to the point where the obstruction starts blocking the rail.

virtual double DtRailObstructionInfo::endBlockDistance

(

)

const [virtual]

The distance along the rail until this obstruction is clear.

virtual void DtRailObstructionInfo::setEndBlockDistance

(

double

v

)

[virtual]

The distance along the rail until this obstruction is clear.

virtual double DtRailObstructionInfo::velocityAlongSegment

(

)

const [virtual]

The aspect of velocity of the obstruction that is along the direction of the segment.

May be negative, if the obstruction is traveling in the opposite direction.

virtual void DtRailObstructionInfo::setVelocityAlongSegment

(

double

v

)

[virtual]

The aspect of velocity of the obstruction that is along the direction of the segment.

May be negative, if the obstruction is traveling in the opposite direction.

virtual void DtRailObstructionInfo::adjustDistances

(

double

adjustmentValue

)

[virtual]

Adds the adjustmentValue to each distance in this info.

Use this to change the perspective of this data from one segment to another.

virtual void DtRailObstructionInfo::merge

(

const DtRailObstructionInfo &

source

)

[virtual]

Changes the data of this class to encompass the data in source.

The merge will make all conservative assumptions, meaning that Only more lanes will be blocked, startBlockDistance will only get smaller and endBlockDistance will only get larger.

---

Member Data Documentation

std::set<int> DtRailObstructionInfo::myLanes [protected]

double DtRailObstructionInfo::myStartBlockDistance [protected]

double DtRailObstructionInfo::myEndBlockDistance [protected]

double DtRailObstructionInfo::myVelocityAlongSegment [protected]

---

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

• include/vrfmodel/railObstructionInfo.h