Emergency 20 Dokumentation  4.1.0
Public Member Functions | Static Public Attributes | List of all members
em5::DensityCalculator Class Reference

EMERGENCY 5 freeplay density falculator. More...

#include <DensityCalculator.h>

Inheritance diagram for em5::DensityCalculator:
Inheritance graph
[legend]
Collaboration diagram for em5::DensityCalculator:
Collaboration graph
[legend]

Public Member Functions

 DensityCalculator ()
 Default constructor. More...
 
 ~DensityCalculator ()
 Destructor. More...
 
bool loadDataFromFile ()
 Load the density factors from JSON file. More...
 
float getEventDensity () const
 Return the current event density. More...
 
std::string getDebug () const
 Get the formatted values as string. More...
 

Static Public Attributes

static const std::string EVENT_DENSITY_DEFINITION_FILENAME
 

Detailed Description

EMERGENCY 5 freeplay density falculator.

Todo:
  • TODO(co) Naming this class "em5::FreeplayDensityCalculator" instead of "em5::DensityCalculator" might be a good idea

Constructor & Destructor Documentation

em5::DensityCalculator::DensityCalculator ( )

Default constructor.

em5::DensityCalculator::~DensityCalculator ( )

Destructor.

Member Function Documentation

std::string em5::DensityCalculator::getDebug ( ) const

Get the formatted values as string.

float em5::DensityCalculator::getEventDensity ( ) const

Return the current event density.

bool em5::DensityCalculator::loadDataFromFile ( )

Load the density factors from JSON file.

Member Data Documentation

const std::string em5::DensityCalculator::EVENT_DENSITY_DEFINITION_FILENAME
static

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