HRoute Class Reference

#include <HRoute.h>

Inheritance diagram for HRoute:

Collaboration diagram for HRoute:

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

Public Member Functions
	HRoute ()
	HRoute (double r, double zmi, double zma, double zexit, const std::string &name)
double	zMin () const
double	zMax () const
double	radius () const
double	zExit () const
virtual double	position () const
virtual double	exit () const
virtual Route *	nextRoute ()
const VolumeContainer &	volumes () const
virtual void	addVolume (ServiceVolume *vol)
virtual void	setNextRoute (Route *nr)
virtual ServiceVolume *	entryVolume (double pos, bool ascending, MsgStream &msg) const
virtual ServiceVolume *	exitVolume (bool ascending, MsgStream &msg) const
const std::string &	name () const
void	setExitVolume (ServiceVolume *vp)

Private Attributes
double	m_radius {}
double	m_zMin {}
double	m_zMax {}
double	m_zExit {}
Route *	m_next {}
VolumeContainer	m_volumes
ServiceVolume *	m_exitVolume
std::string	m_name

Detailed Description

Definition at line 13 of file HRoute.h.

Member Typedef Documentation

VolumeContainer

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

Definition at line 16 of file HRoute.h.

Constructor & Destructor Documentation

HRoute() [1/2]

HRoute::HRoute ( )

inline

Definition at line 18 of file HRoute.h.

: Route()  {}

HRoute() [2/2]

HRoute::HRoute ( double  r, double  zmi, double  zma, double  zexit, const std::string &  name  )

inline

Definition at line 19 of file HRoute.h.

                                                                                   : 
      Route(name),
      m_radius(r), m_zMin(zmi), m_zMax(zma), m_zExit(zexit), m_next(0) {}

Member Function Documentation

addVolume()

virtual void HRoute::addVolume ( ServiceVolume *  vol )

inlinevirtual

Implements Route.

Definition at line 36 of file HRoute.h.

{m_volumes.push_back(vol);}

entryVolume()

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

virtualinherited

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 HRoute::exit ( ) const

inlinevirtual

Implements Route.

Definition at line 30 of file HRoute.h.

{return zExit();}

exitVolume()

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

virtualinherited

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

inlineinherited

Definition at line 42 of file Route.h.

{return m_name;}

nextRoute()

virtual Route* HRoute::nextRoute ( )

inlinevirtual

Implements Route.

Definition at line 32 of file HRoute.h.

{return m_next;}

position()

virtual double HRoute::position ( ) const

inlinevirtual

Implements Route.

Definition at line 28 of file HRoute.h.

{return radius();}

radius()

double HRoute::radius ( ) const

inline

Definition at line 25 of file HRoute.h.

{return m_radius;}

setExitVolume()

void Route::setExitVolume ( ServiceVolume *  vp )

inlineinherited

Definition at line 50 of file Route.h.

                                         { 
    m_exitVolume = vp;
    addVolume(vp);
  }

setNextRoute()

virtual void HRoute::setNextRoute ( Route *  nr )

inlinevirtual

Implements Route.

Definition at line 38 of file HRoute.h.

{m_next = nr;}

volumes()

const VolumeContainer& HRoute::volumes ( ) const

inlinevirtual

Implements Route.

Definition at line 34 of file HRoute.h.

{return m_volumes;}

zExit()

double HRoute::zExit ( ) const

inline

Definition at line 26 of file HRoute.h.

{return m_zExit;}

zMax()

double HRoute::zMax ( ) const

inline

Definition at line 24 of file HRoute.h.

{return m_zMax;}

zMin()

double HRoute::zMin ( ) const

inline

Definition at line 23 of file HRoute.h.

{return m_zMin;}

Member Data Documentation

m_exitVolume

ServiceVolume* Route::m_exitVolume

privateinherited

Definition at line 57 of file Route.h.

m_name

std::string Route::m_name

privateinherited

Definition at line 58 of file Route.h.

m_next

Route* HRoute::m_next {}

private

Definition at line 46 of file HRoute.h.

m_radius

double HRoute::m_radius {}

private

Definition at line 42 of file HRoute.h.

m_volumes

VolumeContainer HRoute::m_volumes

private

Definition at line 48 of file HRoute.h.

m_zExit

double HRoute::m_zExit {}

private

Definition at line 45 of file HRoute.h.

m_zMax

double HRoute::m_zMax {}

private

Definition at line 44 of file HRoute.h.

m_zMin

double HRoute::m_zMin {}

private

Definition at line 43 of file HRoute.h.

---

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

• HRoute.h