AbstractSimLoop Class Reference

yasimavr: AbstractSimLoop Class Reference
yasimavr
Loading...
Searching...
No Matches

Common base class for simulation loops. More...

#include <sim_loop.h>

Inheritance diagram for AbstractSimLoop:
AsyncSimLoop SimLoop

Public Types

enum  State {
  State_Running , State_Step , State_Standby , State_Stopped ,
  State_Done
}
 

Public Member Functions

 AbstractSimLoop (Device &device)
 
virtual ~AbstractSimLoop ()=default
 
AbstractSimLoop::State state () const
 
cycle_count_t cycle () const
 
CycleManagercycle_manager ()
 
const Devicedevice () const
 
Loggerlogger ()
 

Protected Member Functions

cycle_count_t run_device (cycle_count_t final_cycle)
 
void set_state (AbstractSimLoop::State state)
 

Protected Attributes

Devicem_device
 
State m_state
 
CycleManager m_cycle_manager
 
Logger m_logger
 

Detailed Description

Common base class for simulation loops.

Member Enumeration Documentation

◆ State

Enumerator
State_Running 
State_Step 
State_Standby 
State_Stopped 
State_Done 

Constructor & Destructor Documentation

◆ AbstractSimLoop()

AbstractSimLoop::AbstractSimLoop ( Device device)
explicit

◆ ~AbstractSimLoop()

virtual AbstractSimLoop::~AbstractSimLoop ( )
virtualdefault

Member Function Documentation

◆ cycle()

cycle_count_t AbstractSimLoop::cycle ( ) const
inline

◆ cycle_manager()

CycleManager & AbstractSimLoop::cycle_manager ( )
inline

◆ device()

const Device & AbstractSimLoop::device ( ) const
inline

◆ logger()

Logger & AbstractSimLoop::logger ( )
inline

◆ run_device()

cycle_count_t AbstractSimLoop::run_device ( cycle_count_t  final_cycle)
protected

◆ set_state()

void AbstractSimLoop::set_state ( AbstractSimLoop::State  state)
inlineprotected

◆ state()

AbstractSimLoop::State AbstractSimLoop::state ( ) const
inline

Member Data Documentation

◆ m_cycle_manager

CycleManager AbstractSimLoop::m_cycle_manager
protected

◆ m_device

Device& AbstractSimLoop::m_device
protected

◆ m_logger

Logger AbstractSimLoop::m_logger
protected

◆ m_state

State AbstractSimLoop::m_state
protected

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