Route Class Reference

#include <Route.h>

Inheritance diagram for Route:

Collaboration diagram for Route:

Public Types
typedef std::vector< ServiceVolume * >	VolumeContainer

Public Member Functions
virtual ServiceVolume *	entryVolume (double pos, bool ascending, MsgStream &msg) const
virtual ServiceVolume *	exitVolume (bool ascending, MsgStream &msg) const
	Route ()
	Route (const std::string &name)
virtual	~Route ()
virtual double	position () const =0
virtual double	exit () const =0
virtual Route *	nextRoute ()=0
virtual const VolumeContainer &	volumes () const =0
virtual void	setNextRoute (Route *nr)=0
const std::string &	name () const
virtual void	addVolume (ServiceVolume *vol)=0
void	setExitVolume (ServiceVolume *vp)

Private Attributes
ServiceVolume *	m_exitVolume
std::string	m_name

Detailed Description

Definition at line 15 of file Route.h.

Member Typedef Documentation

VolumeContainer

typedef std::vector<ServiceVolume*> Route::VolumeContainer

Definition at line 18 of file Route.h.

Constructor & Destructor Documentation

Route() [1/2]

Route::Route ( )

inline

Definition at line 25 of file Route.h.

: m_exitVolume(0) {}

Route() [2/2]

Route::Route ( const std::string & name )

inline

Definition at line 26 of file Route.h.

: m_exitVolume(0), m_name(name) {}

~Route()

virtual Route::~Route ( )

inlinevirtual

Definition at line 28 of file Route.h.

{}

Member Function Documentation

addVolume()

virtual void Route::addVolume ( ServiceVolume * vol )

pure virtual

Implemented in HRoute, and VRoute.

entryVolume()

ServiceVolume * Route::entryVolume ( double pos, bool ascending, MsgStream & msg ) const

virtual

Definition at line 10 of file Route.cxx.

{
  if (msg.level() <= MSG::DEBUG) {
    msg << MSG::DEBUG  << "entering entryVolume with ascending = " << ascending
        << " and pos = " << pos << endmsg;
  }
  if (volumes().empty()) return nullptr;
 
  //  if (volumes().front()->contains(pos)) return volumes().front();
  //  else if (volumes().back()->contains(pos)) return volumes().back();
  //  else {
  //should iterate to find exit volume
  if ( ascending) {
    for (VolumeContainer::const_iterator i=volumes().begin(); i!=volumes().end(); ++i) {
 
      if (msg.level() <= MSG::DEBUG) {
        msg << MSG::DEBUG  << "Comparing " << pos << " and " << (**i).position() << endmsg;
      }
      if (pos < (**i).position()) {
        if (msg.level() <= MSG::DEBUG) {
          msg << MSG::DEBUG  << "volume at pos " << (**i).radius()
              << ", " << (**i).zPos() << " contains exit point" << endmsg;
        }
        return *i;
      }
      else if (msg.level() <= MSG::DEBUG) {
          msg << MSG::DEBUG  << "volume at pos " << (**i).radius()
              << ", " << (**i).zPos() << " does not contain exit point" << endmsg;
      }
    }
    return volumes().front();  // catch-all
  } 
  else {
    for (VolumeContainer::const_reverse_iterator i=volumes().rbegin(); i!=volumes().rend(); ++i) {
      if ((**i).contains(pos)) return *i;
    }
    return volumes().back(); // catch-all
  }
  //}
}

exit()

virtual double Route::exit ( ) const

pure virtual

Implemented in HRoute, and VRoute.

exitVolume()

ServiceVolume * Route::exitVolume ( bool ascending, MsgStream & msg ) const

virtual

Definition at line 51 of file Route.cxx.

{
  if (msg.level() <= MSG::DEBUG) {
    msg << MSG::DEBUG  << "entering exitVolume with ascending = " << ascending
        << " and route.exit() = " << exit() << endmsg;
  }
  if (m_exitVolume != nullptr) return m_exitVolume;
 
  // returns the volume closest to the exit point, coming from the given direction
  if (volumes().empty()) return nullptr;
  if ( ascending) {
    for (VolumeContainer::const_iterator i=volumes().begin(); i!=volumes().end(); ++i) {
      if ((**i).contains(exit())) return *i;
      else if (msg.level() <= MSG::DEBUG) {
        msg << MSG::DEBUG  << "volume at pos " << (**i).radius()
            << ", " << (**i).zPos() << " does not contain exit point" << endmsg;
      }
    }
    return volumes().back();  // catch-all
  } 
  else {
    for (VolumeContainer::const_reverse_iterator i=volumes().rbegin(); i!=volumes().rend(); ++i) {
      if ((**i).contains(exit())) return *i;
    }
    return volumes().front(); // catch-all
  }
}

name()

const std::string & Route::name ( ) const

inline

Definition at line 42 of file Route.h.

{return m_name;}

nextRoute()

virtual Route * Route::nextRoute ( )

pure virtual

Implemented in HRoute, and VRoute.

position()

virtual double Route::position ( ) const

pure virtual

Implemented in HRoute, and VRoute.

setExitVolume()

void Route::setExitVolume ( ServiceVolume * vp )

inline

Definition at line 50 of file Route.h.

                                         { 
    m_exitVolume = vp;
    addVolume(vp);
  }

setNextRoute()

virtual void Route::setNextRoute ( Route * nr )

pure virtual

Implemented in HRoute, and VRoute.

volumes()

virtual const VolumeContainer & Route::volumes ( ) const

pure virtual

Implemented in HRoute, and VRoute.

Member Data Documentation

m_exitVolume

ServiceVolume* Route::m_exitVolume

private

Definition at line 57 of file Route.h.

m_name

std::string Route::m_name

private

Definition at line 58 of file Route.h.

---

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

• Route.h
• Route.cxx