VRoute Class Reference

#include <VRoute.h>

Inheritance diagram for VRoute:

Collaboration diagram for VRoute:

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

Public Member Functions
	VRoute ()
	VRoute (double z, double rmi, double rma, double rexit, const std::string &name)
double	rMin () const
double	rMax () const
double	zPos () const
double	rExit () const
virtual double	position () const
virtual double	exit () const
virtual Route *	nextRoute ()
virtual 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_zPos {}
double	m_rMin {}
double	m_rMax {}
double	m_rExit {}
Route *	m_next {}
VolumeContainer	m_volumes
ServiceVolume *	m_exitVolume
std::string	m_name

Detailed Description

Definition at line 13 of file VRoute.h.

Member Typedef Documentation

VolumeContainer

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

Definition at line 16 of file VRoute.h.

Constructor & Destructor Documentation

VRoute() [1/2]

VRoute::VRoute ( )

inline

Definition at line 18 of file VRoute.h.

: Route() {}

VRoute() [2/2]

VRoute::VRoute ( double z, double rmi, double rma, double rexit, const std::string & name )

inline

Definition at line 19 of file VRoute.h.

                                                                                  :
      Route(name), 
      m_zPos(z), m_rMin(rmi), m_rMax(rma), m_rExit(rexit), m_next(0){}

Member Function Documentation

addVolume()

virtual void VRoute::addVolume ( ServiceVolume * vol )

inlinevirtual

Implements Route.

Definition at line 36 of file VRoute.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 VRoute::exit ( ) const

inlinevirtual

Implements Route.

Definition at line 30 of file VRoute.h.

{return rExit();}

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 * VRoute::nextRoute ( )

inlinevirtual

Implements Route.

Definition at line 32 of file VRoute.h.

{return m_next;}

position()

virtual double VRoute::position ( ) const

inlinevirtual

Implements Route.

Definition at line 28 of file VRoute.h.

{return zPos();}

rExit()

double VRoute::rExit ( ) const

inline

Definition at line 26 of file VRoute.h.

{return m_rExit;}

rMax()

double VRoute::rMax ( ) const

inline

Definition at line 24 of file VRoute.h.

{return m_rMax;}

rMin()

double VRoute::rMin ( ) const

inline

Definition at line 23 of file VRoute.h.

{return m_rMin;}

setExitVolume()

void Route::setExitVolume ( ServiceVolume * vp )

inlineinherited

Definition at line 50 of file Route.h.

                                         { 
    m_exitVolume = vp;
    addVolume(vp);
  }

setNextRoute()

virtual void VRoute::setNextRoute ( Route * nr )

inlinevirtual

Implements Route.

Definition at line 38 of file VRoute.h.

{m_next = nr;}

volumes()

virtual const VolumeContainer & VRoute::volumes ( ) const

inlinevirtual

Implements Route.

Definition at line 34 of file VRoute.h.

{return m_volumes;}

zPos()

double VRoute::zPos ( ) const

inline

Definition at line 25 of file VRoute.h.

{return m_zPos;}

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* VRoute::m_next {}

private

Definition at line 59 of file VRoute.h.

{};

m_rExit

double VRoute::m_rExit {}

private

Definition at line 58 of file VRoute.h.

{};

m_rMax

double VRoute::m_rMax {}

private

Definition at line 57 of file VRoute.h.

{};

m_rMin

double VRoute::m_rMin {}

private

Definition at line 56 of file VRoute.h.

{};

m_volumes

VolumeContainer VRoute::m_volumes

private

Definition at line 61 of file VRoute.h.

m_zPos

double VRoute::m_zPos {}

private

Definition at line 55 of file VRoute.h.

{};

---

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

• VRoute.h