rapid
A ROS robotics library.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
rapid::utils::MockRandomNumber Class Reference

A mock random number generator for unit testing. More...

#include <random.h>

Inheritance diagram for rapid::utils::MockRandomNumber:
rapid::utils::RandomNumberInterface

Public Member Functions

 MockRandomNumber ()
 
int rand () const
 Generate a random number in [0, RAND_MAX]. More...
 
void set_rand (int val)
 Set what rand() will return next. More...
 
- Public Member Functions inherited from rapid::utils::RandomNumberInterface
virtual ~RandomNumberInterface ()
 

Detailed Description

A mock random number generator for unit testing.

Usage:

rng.set_rand(5);
rng.rand(); // Returns 5

Definition at line 33 of file random.h.

Constructor & Destructor Documentation

rapid::utils::MockRandomNumber::MockRandomNumber ( )

Member Function Documentation

int rapid::utils::MockRandomNumber::rand ( ) const
virtual

Generate a random number in [0, RAND_MAX].

This is the same API as cstdlib's rand().

Returns
A uniformly distributed random number in the range [0, RAND_MAX].

Implements rapid::utils::RandomNumberInterface.

void rapid::utils::MockRandomNumber::set_rand ( int  val)

Set what rand() will return next.


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