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() [1/2]

StepTrigger::StepTrigger ( )

inline

StepTrigger() [2/2]

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

inline

Member Function Documentation

get_period()

int StepTrigger::get_period ( ) const

inline

Here is the caller graph for this function:

has_been_triggered()

bool StepTrigger::has_been_triggered ( int  step ) const

inline

Here is the caller graph for this function:

is_triggered()

bool StepTrigger::is_triggered ( int  step ) const

inline

Here is the caller graph for this function:

trigger_count()

int StepTrigger::trigger_count ( int  step ) const

inline

Returns how many times the action has been triggered

Parameters

[in]

step

Index of the current step

Here is the caller graph for this function:

Member Data Documentation

first_step

int StepTrigger::first_step

private

First step it can be called.

initialized

bool StepTrigger::initialized

private

last_step

int StepTrigger::last_step

private

Last step it can be called.

period

int StepTrigger::period

private

Number of steps between trigger.

---

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

• /p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/step_trigger.hpp