Helios++
Helios software for LiDAR simulations
LinearVoidStepLoop< StepInput > Class Template Reference

Class extending VoidStepLoop to support a continous linear step loop without cyclic behavior. More...

#include <LinearVoidStepLoop.h>

Inheritance diagram for LinearVoidStepLoop< StepInput >:
Collaboration diagram for LinearVoidStepLoop< StepInput >:

Public Member Functions

 LinearVoidStepLoop (std::function< void(StepInput ...)> f)
 Linear void step loop constructor receiving interval and computation region function.
 
bool doStep (StepInput ... input) override
 Handle current loop iteration and advances to next one without cyclic behavior. More...
 
void nextStep () override
 Advances to current loop iteration without cyclic behavior. More...
 
- Public Member Functions inherited from VoidStepLoop< StepInput ... >
 VoidStepLoop (int const stepInterval, std::function< void(StepInput ...)> f)
 Void step loop constructor receiving interval and computation region function.
 
void handleStep (StepInput ... input) override
 Implementation of StepLoop::handleStep for computation regions with void return. More...
 
- Public Member Functions inherited from StepLoop< StepInput ... >
 StepLoop (int const stepInterval)
 Step loop constructor receiving interval and computation region function.
 
virtual int getStepInterval () const
 Obtain the step interval. More...
 
virtual void setStepInterval (int const stepInterval)
 Set the step interval. More...
 
virtual int getCurrentStep () const
 Obtain the current step of the step loop. More...
 
virtual void setCurrentStep (int const currentStep)
 Set the current step for the step loop. More...
 

Additional Inherited Members

- Protected Attributes inherited from VoidStepLoop< StepInput ... >
std::function< void(StepInput ...)> f
 The function to be invoked when computation region function has been reached.
 
- Protected Attributes inherited from StepLoop< StepInput ... >
int stepInterval
 Specify how many simulation steps must elapse so the step loop enters its computation region. More...
 
int currentStep
 Stores the current step. More...
 

Detailed Description

template<typename ... StepInput>
class LinearVoidStepLoop< StepInput >

Class extending VoidStepLoop to support a continous linear step loop without cyclic behavior.

Author
Alberto M. Esmoris Pena
Version
1.0
See also
VoidStepLoop

Member Function Documentation

◆ doStep()

template<typename ... StepInput>
bool LinearVoidStepLoop< StepInput >::doStep ( StepInput ...  input)
inlineoverridevirtual

Handle current loop iteration and advances to next one without cyclic behavior.

Returns
True always, because it always compute
See also
StepLoop::doStep

Reimplemented from StepLoop< StepInput ... >.

◆ nextStep()

template<typename ... StepInput>
void LinearVoidStepLoop< StepInput >::nextStep ( )
inlineoverridevirtual

Advances to current loop iteration without cyclic behavior.

See also
StepLoop::nextStep

Reimplemented from StepLoop< StepInput ... >.


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