CARMA C++
carma::loberotator::SimData Class Reference

Simulated data generator class. More...

#include <carma/loberotator/SimData.h>

Public Member Functions

void setOffset (double offset)
 Set offset. More...
 
void setRate (double rate)
 Set rate. More...
 
 SimData (double minVal, double maxVal)
 Constructor. More...
 
 SimData (double minVal, double maxVal, double offset, double rate)
 Constructor. More...
 
double simData (double x)
 Generate simulated data. More...
 
double simData ()
 Generate simulated data, keeping x value internally. More...
 

Detailed Description

Simulated data generator class.

data=min+mod(offset + rate*x) where mod() does modulus on (max-min)

Definition at line 24 of file SimData.h.

Constructor & Destructor Documentation

carma::loberotator::SimData::SimData ( double  minVal,
double  maxVal 
)

Constructor.

Parameters
minValminimum value that will be generated
maxValmaximum value that will be generated
carma::loberotator::SimData::SimData ( double  minVal,
double  maxVal,
double  offset,
double  rate 
)

Constructor.

Parameters
minValminimum value that will be generated
maxValmaximum value that will be generated
offset
rate

Member Function Documentation

void carma::loberotator::SimData::setOffset ( double  offset)

Set offset.

Parameters
offset
void carma::loberotator::SimData::setRate ( double  rate)

Set rate.

Parameters
rate
double carma::loberotator::SimData::simData ( double  x)

Generate simulated data.

Parameters
xx-value to use to generate data
double carma::loberotator::SimData::simData ( )

Generate simulated data, keeping x value internally.

The x value is incremented by 1 each time this is called.


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