XGC1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
StepTrigger Class Reference

#include <step_trigger.hpp>

Public Member Functions

 StepTrigger ()
 
 StepTrigger (int period, int first_step_in=-1, int last_step_in=-1)
 
bool is_triggered (int step) const
 
bool has_been_triggered (int step) const
 
int get_period () const
 
int trigger_count (int step) const
 

Private Attributes

bool initialized
 
int period
 Number of steps between trigger. More...
 
int first_step
 First step it can be called. More...
 
int last_step
 Last step it can be called. More...
 

Constructor & Destructor Documentation

StepTrigger::StepTrigger ( )
inline
StepTrigger::StepTrigger ( int  period,
int  first_step_in = -1,
int  last_step_in = -1 
)
inline

Member Function Documentation

int StepTrigger::get_period ( ) const
inline

Here is the caller graph for this function:

bool StepTrigger::has_been_triggered ( int  step) const
inline

Here is the caller graph for this function:

bool StepTrigger::is_triggered ( int  step) const
inline

Here is the caller graph for this function:

int StepTrigger::trigger_count ( int  step) const
inline

Returns how many times the action has been triggered

Parameters
[in]stepIndex of the current step

Member Data Documentation

int StepTrigger::first_step
private

First step it can be called.

bool StepTrigger::initialized
private
int StepTrigger::last_step
private

Last step it can be called.

int StepTrigger::period
private

Number of steps between trigger.


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