RobWorkProject
Public Types | Public Member Functions | List of all members
SimulatorStatistics Class Reference

Statistics utility for automatic generation of data set based on a SimulatorLogScope. More...

#include <SimulatorStatistics.hpp>

Public Types

typedef rw::common::Ptr< SimulatorStatisticsPtr
 Smart pointer type of SimulatorStatistics.
 
typedef std::map< std::string, std::vector< double > > DataSeries
 Type of a DataSeries collection (each series is a name and a list of numbers)
 

Public Member Functions

 SimulatorStatistics (const class SimulatorLogScope *log)
 Create a new statistics on the given SimulatorLogScope. More...
 
virtual ~SimulatorStatistics ()
 Destructor.
 
void update ()
 Generate statistics.
 
bool hasData () const
 Check if any statistics was generated.
 
const DataSeriesgetSeries () const
 Get the found statistics. More...
 

Detailed Description

Statistics utility for automatic generation of data set based on a SimulatorLogScope.

Constructor & Destructor Documentation

◆ SimulatorStatistics()

SimulatorStatistics ( const class SimulatorLogScope log)

Create a new statistics on the given SimulatorLogScope.

Note
Please use the SimulatorLogScope::getStatistics function instead.
All children log scopes will have their statistics updated or added.
Parameters
log[in/out] the log to create statistics based on.

Member Function Documentation

◆ getSeries()

const DataSeries& getSeries ( ) const

Get the found statistics.

Returns
a collection of data series.

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