SEvMgr Logo  0.2.0
C++ Simulation-Oriented Discrete Event Management Library
SEVMGR::SEVMGR_Service Class Reference

class holding the services related to Travel Demand Generation. More...

#include <sevmgr/SEVMGR_Service.hpp>

List of all members.

Public Member Functions

 SEVMGR_Service (const stdair::BasLogParams &, const stdair::BasDBParams &)
 Constructor.
 SEVMGR_Service (const stdair::BasLogParams &)
 SEVMGR_Service (stdair::STDAIR_ServicePtr_T)
 ~SEVMGR_Service ()
void buildSampleBom ()
stdair::ProgressStatusSet popEvent (stdair::EventStruct &) const
bool isQueueDone () const
void reset () const
std::string csvDisplay () const

Detailed Description

class holding the services related to Travel Demand Generation.


Constructor & Destructor Documentation

SEVMGR::SEVMGR_Service::SEVMGR_Service ( const stdair::BasLogParams &  iLogParams,
const stdair::BasDBParams &  iDBParams 
)

Constructor.

The initSevmgrService() method is called; see the corresponding documentation for more details.

A reference on an output stream is given, so that log outputs can be directed onto that stream.

Moreover, database connection parameters are given, so that a session can be created on the corresponding database.

Parameters:
conststdair::BasLogParams& Parameters for the output log stream.
conststdair::BasDBParams& Parameters for the database access.

Definition at line 39 of file SEVMGR_Service.cpp.

SEVMGR::SEVMGR_Service::SEVMGR_Service ( const stdair::BasLogParams &  iLogParams)

Constructor.

The initSevmgrService() method is called; see the corresponding documentation for more details.

A reference on an output stream is given, so that log outputs can be directed onto that stream.

Parameters:
conststdair::BasLogParams& Parameters for the output log stream.

Definition at line 60 of file SEVMGR_Service.cpp.

SEVMGR::SEVMGR_Service::SEVMGR_Service ( stdair::STDAIR_ServicePtr_T  ioSTDAIR_Service_ptr)

Constructor.

The initSevmgrService() method is called; see the corresponding documentation for more details.

Moreover, as no reference on any output stream is given, neither any database access parameter is given, it is assumed that the StdAir log service has already been initialised with the proper log output stream by some other methods in the calling chain (for instance, when the SEVMGR_Service is itself being initialised by another library service such as DSIM_Service).

Parameters:
stdair::STDAIR_ServicePtr_THandler on the STDAIR_Service.

Definition at line 81 of file SEVMGR_Service.cpp.

SEVMGR::SEVMGR_Service::~SEVMGR_Service ( )

Destructor.

Definition at line 97 of file SEVMGR_Service.cpp.


Member Function Documentation

void SEVMGR::SEVMGR_Service::buildSampleBom ( )

Build a sample BOM tree.

Definition at line 171 of file SEVMGR_Service.cpp.

Referenced by main(), and SEVMGR::PYEventQueueManager::sevmgr().

stdair::ProgressStatusSet SEVMGR::SEVMGR_Service::popEvent ( stdair::EventStruct &  ioEventStruct) const

Pop the next coming (in time) event, and remove it from the event queue.

  • The next coming (in time) event corresponds to the event having the earliest date-time stamp. In other words, it is the first/front element of the event queue.
  • That (first) event/element is then removed from the event queue
  • The progress status is updated for the corresponding demand stream.
Returns:
stdair::EventStruct A copy of the event structure, which comes first in time from within the event queue.

Definition at line 215 of file SEVMGR_Service.cpp.

bool SEVMGR::SEVMGR_Service::isQueueDone ( ) const

States whether the event queue has reached the end.

For now, that method states whether the event queue is empty.

Definition at line 233 of file SEVMGR_Service.cpp.

void SEVMGR::SEVMGR_Service::reset ( ) const

Reset the context of the demand streams for another demand generation without having to reparse the demand input file.

Definition at line 255 of file SEVMGR_Service.cpp.

std::string SEVMGR::SEVMGR_Service::csvDisplay ( ) const

Recursively display (dump in the returned string) the objects of the BOM tree.

Returns:
std::string Output string in which the BOM tree is logged/dumped.

Definition at line 191 of file SEVMGR_Service.cpp.


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