Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Menge::Math::Vec2DGenerator Class Referenceabstract

Generic abstract class which generates a 2D vector float values. More...

#include <RandGenerator.h>

Inheritance diagram for Menge::Math::Vec2DGenerator:
Menge::Math::AABBUniformPosGenerator Menge::Math::Const2DGenerator Menge::Math::OBBUniformPosGenerator Menge::Math::Zero2DGenerator

Public Member Functions

 Vec2DGenerator ()
 Constructor.
 
virtual ~Vec2DGenerator ()
 Virtual destructor.
 
virtual Vector2 getValue () const =0
 Return a value based on the 2D float generation rules. More...
 
virtual Vector2 getValueConcurrent () const =0
 Return a value based on the 2D float generation rules - performed in a thread-safe manner. More...
 
virtual void print (Logger &out) const =0
 Function for converting the generator to a string on a output stream. More...
 
virtual Vec2DGeneratorcopy () const =0
 Create a copy of itself. More...
 

Detailed Description

Generic abstract class which generates a 2D vector float values.

Member Function Documentation

virtual Vec2DGenerator* Menge::Math::Vec2DGenerator::copy ( ) const
pure virtual

Create a copy of itself.

This is the basic functionality that must be overwridden by derived classes.

Returns
A pointer to a new generator which is a copy of this one. The caller of this function is responsible for freeing up the memory for the copy.

Implemented in Menge::Math::OBBUniformPosGenerator, Menge::Math::AABBUniformPosGenerator, Menge::Math::Const2DGenerator, and Menge::Math::Zero2DGenerator.

virtual Vector2 Menge::Math::Vec2DGenerator::getValue ( ) const
pure virtual

Return a value based on the 2D float generation rules.

This is the basic functionality that must be overwridden by derived classes.

Returns
A 2D float value.

Implemented in Menge::Math::OBBUniformPosGenerator, Menge::Math::AABBUniformPosGenerator, Menge::Math::Const2DGenerator, and Menge::Math::Zero2DGenerator.

virtual Vector2 Menge::Math::Vec2DGenerator::getValueConcurrent ( ) const
pure virtual

Return a value based on the 2D float generation rules - performed in a thread-safe manner.

This is the basic functionality that must be overwridden by derived classes.

Returns
A 2D float value.

Implemented in Menge::Math::OBBUniformPosGenerator, Menge::Math::AABBUniformPosGenerator, Menge::Math::Const2DGenerator, and Menge::Math::Zero2DGenerator.

virtual void Menge::Math::Vec2DGenerator::print ( Logger out) const
pure virtual

Function for converting the generator to a string on a output stream.

This must be overridden by each derived class to provide a string format of the float generator.

Parameters
outThe output stream to write the string representation to.

Implemented in Menge::Math::OBBUniformPosGenerator, Menge::Math::AABBUniformPosGenerator, Menge::Math::Const2DGenerator, and Menge::Math::Zero2DGenerator.


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