SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSTriggeredReader Class Referenceabstract

#include <MSTriggeredReader.h>

Inheritance diagram for MSTriggeredReader:
MSTriggeredXMLReader

Public Member Functions

void init ()
 
bool isInitialised () const
 
SUMOTime wrappedExecute (SUMOTime current)
 
virtual ~MSTriggeredReader ()
 Destructor. More...
 

Protected Member Functions

virtual void inputEndReached ()=0
 
 MSTriggeredReader (MSNet &net)
 Constructor (for an abstract class) More...
 
virtual void myInit ()=0
 
virtual bool processNextEntryReaderTriggered ()=0
 Processes the next event Returns true if the next element shall be read (a new timestemp is then available also) Returns false if the action could not be accomplished; this method is then called in the next step again. More...
 
virtual bool readNextTriggered ()=0
 Reads from the file. More...
 

Protected Attributes

SUMOTime myOffset
 The offset to the next event. More...
 
bool myWasInitialised
 

Private Member Functions

 MSTriggeredReader (const MSTriggeredReader &)
 Invalidated copy constructor. More...
 
MSTriggeredReaderoperator= (const MSTriggeredReader &)
 Invalidated assignment operator. More...
 

Detailed Description

Superclass for structures that read from a file where the times the next reading is performed are triggered by events,

Definition at line 46 of file MSTriggeredReader.h.

Constructor & Destructor Documentation

MSTriggeredReader::~MSTriggeredReader ( )
virtual

Destructor.

Definition at line 47 of file MSTriggeredReader.cpp.

MSTriggeredReader::MSTriggeredReader ( MSNet net)
protected

Constructor (for an abstract class)

Definition at line 43 of file MSTriggeredReader.cpp.

MSTriggeredReader::MSTriggeredReader ( const MSTriggeredReader )
private

Invalidated copy constructor.

Member Function Documentation

void MSTriggeredReader::init ( )

Definition at line 51 of file MSTriggeredReader.cpp.

References myInit(), and myWasInitialised.

Referenced by wrappedExecute().

virtual void MSTriggeredReader::inputEndReached ( )
protectedpure virtual
bool MSTriggeredReader::isInitialised ( ) const

Definition at line 58 of file MSTriggeredReader.cpp.

References myWasInitialised.

Referenced by wrappedExecute().

virtual void MSTriggeredReader::myInit ( )
protectedpure virtual

Implemented in MSTriggeredXMLReader.

Referenced by init().

MSTriggeredReader& MSTriggeredReader::operator= ( const MSTriggeredReader )
private

Invalidated assignment operator.

virtual bool MSTriggeredReader::processNextEntryReaderTriggered ( )
protectedpure virtual

Processes the next event Returns true if the next element shall be read (a new timestemp is then available also) Returns false if the action could not be accomplished; this method is then called in the next step again.

Referenced by wrappedExecute().

virtual bool MSTriggeredReader::readNextTriggered ( )
protectedpure virtual

Reads from the file.

Implemented in MSTriggeredXMLReader.

Referenced by wrappedExecute().

SUMOTime MSTriggeredReader::wrappedExecute ( SUMOTime  current)

Field Documentation

SUMOTime MSTriggeredReader::myOffset
protected

The offset to the next event.

Definition at line 74 of file MSTriggeredReader.h.

Referenced by MSTriggeredXMLReader::myInit(), and wrappedExecute().

bool MSTriggeredReader::myWasInitialised
protected

Definition at line 75 of file MSTriggeredReader.h.

Referenced by init(), and isInitialised().


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