The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
DataSource Interface Reference

Interface to an entity that is able to evaluate sample points. More...

Inheritance diagram for DataSource:
Inheritance graph
[legend]

Public Member Functions

void submitSamplesForEvaluation (SamplePoint[] points)
 Schedule a number of sample points for evaluation. More...
 
SamplePoint fetchEvaluatedSample ()
 Get the next evaluated point. More...
 
int getNumPendingSamples ()
 Return the number of samples pending evaluation. More...
 
int getNumEvaluatedSamples ()
 Return the number of samples that have already been evaluated and are waiting to be fetched. More...
 
double getAverageEvaluationTime ()
 Get the average time in seconds to simulate one data point. More...
 
void cleanup ()
 Clean up the threads started and the resources used by the sample evaluator. More...
 
DataSourceStatus getStatus ()
 Get the status of the sample evaluator. More...
 

Detailed Description

Interface to an entity that is able to evaluate sample points.

Member Function Documentation

void cleanup ( )

Clean up the threads started and the resources used by the sample evaluator.

Called automatically when the DataSource is not to be used anymore.

Implemented in DatasetDataSource, LocalDataSource, DistributedDataSource, BatchDataSource, RemoteSGEDataSource, DefaultDataSource, BasicDataSource, ThreadedBatchDataSource, and ThreadedBasicDataSource.

SamplePoint fetchEvaluatedSample ( )

Get the next evaluated point.

Implemented in DatasetDataSource, and DefaultDataSource.

double getAverageEvaluationTime ( )

Get the average time in seconds to simulate one data point.

Implemented in DatasetDataSource, and DefaultDataSource.

int getNumEvaluatedSamples ( )

Return the number of samples that have already been evaluated and are waiting to be fetched.

Implemented in DatasetDataSource, and DefaultDataSource.

int getNumPendingSamples ( )

Return the number of samples pending evaluation.

Implemented in DatasetDataSource, and DefaultDataSource.

DataSourceStatus getStatus ( )

Get the status of the sample evaluator.

This status contains, for example, if the sample evaluator is still capable of evaluating samples and how many it can evaluate at once.

Returns
The status.

Implemented in DatasetDataSource, DistributedDataSource, and DefaultDataSource.

void submitSamplesForEvaluation ( SamplePoint[]  points)

Schedule a number of sample points for evaluation.

Implemented in DatasetDataSource, and DefaultDataSource.


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