Eclipse SUMO - Simulation of Urban MObility
MSRailSignalConstraint Class Referenceabstract

A base class for constraints. More...

#include <MSRailSignalConstraint.h>

Inheritance diagram for MSRailSignalConstraint:
[legend]

Public Member Functions

virtual bool cleared () const =0
 whether the constraint has been met More...
 
virtual std::string getDescription () const
 
 MSRailSignalConstraint ()
 Constructor. More...
 
virtual ~MSRailSignalConstraint ()
 Destructor. More...
 

Static Public Member Functions

static void cleanup ()
 clean up state More...
 
static void clearState ()
 Clear all constraint states before quick-loading state. More...
 
static void saveState (OutputDevice &out)
 Saves the current constraint states into the given stream. More...
 

Static Protected Member Functions

static std::string getVehID (const std::string &tripID)
 

Detailed Description

A base class for constraints.

Definition at line 39 of file MSRailSignalConstraint.h.

Constructor & Destructor Documentation

◆ MSRailSignalConstraint()

MSRailSignalConstraint::MSRailSignalConstraint ( )
inline

Constructor.

Definition at line 43 of file MSRailSignalConstraint.h.

◆ ~MSRailSignalConstraint()

virtual MSRailSignalConstraint::~MSRailSignalConstraint ( )
inlinevirtual

Destructor.

Definition at line 46 of file MSRailSignalConstraint.h.

Member Function Documentation

◆ cleanup()

void MSRailSignalConstraint::cleanup ( )
static

clean up state

Definition at line 45 of file MSRailSignalConstraint.cpp.

References MSRailSignalConstraint_Predecessor::cleanup().

Referenced by MSNet::clearAll().

Here is the caller graph for this function:

◆ cleared()

virtual bool MSRailSignalConstraint::cleared ( ) const
pure virtual

whether the constraint has been met

Implemented in MSRailSignalConstraint_Predecessor.

Referenced by MSRailSignal::constraintsAllow(), and MSRailSignal::hasInsertionConstraint().

Here is the caller graph for this function:

◆ clearState()

void MSRailSignalConstraint::clearState ( )
static

Clear all constraint states before quick-loading state.

Definition at line 55 of file MSRailSignalConstraint.cpp.

References MSRailSignalConstraint_Predecessor::clearState().

Referenced by MSTLLogicControl::clearState().

Here is the caller graph for this function:

◆ getDescription()

virtual std::string MSRailSignalConstraint::getDescription ( ) const
inlinevirtual

Reimplemented in MSRailSignalConstraint_Predecessor.

Definition at line 51 of file MSRailSignalConstraint.h.

Referenced by MSRailSignal::constraintsAllow(), and MSRailSignal::hasInsertionConstraint().

Here is the caller graph for this function:

◆ getVehID()

std::string MSRailSignalConstraint::getVehID ( const std::string &  tripID)
staticprotected

Definition at line 60 of file MSRailSignalConstraint.cpp.

References Named::getID(), MSNet::getInstance(), SUMOTrafficObject::getParameter(), Parameterised::getParameter(), MSNet::getVehicleControl(), MSVehicleControl::loadedVehBegin(), and MSVehicleControl::loadedVehEnd().

Referenced by MSRailSignalConstraint_Predecessor::getDescription().

Here is the caller graph for this function:

◆ saveState()

void MSRailSignalConstraint::saveState ( OutputDevice out)
static

Saves the current constraint states into the given stream.

Definition at line 50 of file MSRailSignalConstraint.cpp.

References MSRailSignalConstraint_Predecessor::saveState().

Referenced by MSTLLogicControl::saveState().

Here is the caller graph for this function:

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