stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType > Class Template Reference

#include <BaseThread.h>

Inheritance diagram for stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >:

Public Member Functions
	BaseThread (StaminaModelBuilder< ValueType, RewardModelType, StateType > *parent)
virtual void	mainLoop ()=0
void	startThread ()
const StaminaModelBuilder< ValueType, RewardModelType, StateType > *	getParent ()
void	join ()
void	terminate ()

Protected Attributes
bool	finished

Detailed Description

template<typename StateType, typename RewardModelType, typename ValueType>
class stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >

Base class for all threads. Automatically constructs a thread which runs the mainLoop function.

Constructor & Destructor Documentation

BaseThread()

template<typename StateType , typename RewardModelType , typename ValueType >

stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >::BaseThread

(

StaminaModelBuilder< ValueType, RewardModelType, StateType > *

parent

)

Constructs a BaseThread

Parameters

parent

The model builder who owns this thread

Member Function Documentation

getParent()

template<typename StateType , typename RewardModelType , typename ValueType >

const StaminaModelBuilder< ValueType, RewardModelType, StateType > * stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >::getParent

Gets the pointer to the model builder owning this thread

Returns

This thread's parent

join()

template<typename StateType , typename RewardModelType , typename ValueType >

void stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >::join

(

)

Joins the

mainLoop()

template<typename StateType , typename RewardModelType , typename ValueType >

virtual void stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >::mainLoop ( )

pure virtual

Pure virtual function for the main loop. When this function returns, the thread dies.

Implemented in stamina::builder::threads::ControlThread< StateType, RewardModelType, ValueType >, and stamina::builder::threads::ExplorationThread< StateType, RewardModelType, ValueType >.

startThread()

template<typename StateType , typename RewardModelType , typename ValueType >

void stamina::builder::threads::BaseThread< StateType, RewardModelType, ValueType >::startThread

Creates and starts this thread in the background

---

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

• /home/josh/Documents/Work/stamina-cplusplus/src/stamina/builder/threads/BaseThread.h
• /home/josh/Documents/Work/stamina-cplusplus/src/stamina/builder/threads/BaseThread.cpp