Scheduler
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mdp::PriorityState Class Referenceabstract

a single state of the state space More...

#include <priorityState.h>

Inheritance diagram for Mdp::PriorityState:
Prio

Public Member Functions

virtual ~PriorityState ()
 
virtual std::string getName ()=0
 returns the name of that state More...
 
virtual bool isInState ()=0
 Given the information provided by the DomainModel, this function checks if the system is in that state. More...
 

Protected Member Functions

template<typename T >
std::shared_ptr< T > getModel ()
 

Protected Attributes

std::shared_ptr< DomainModeldomainModel {nullptr}
 

Detailed Description

a single state of the state space

This class should be used to model states that do not belong to dimensions. The qualifier of "priority" comes from the fact that, when determining the current state, the framework first checks if the system is in any of the priority states, and if not, only then will determine what position the system has in the "dimensioned" part of the state space.

Definition at line 31 of file priorityState.h.

Constructor & Destructor Documentation

virtual Mdp::PriorityState::~PriorityState ( )
inlinevirtual

Definition at line 36 of file priorityState.h.

Member Function Documentation

template<typename T >
std::shared_ptr<T> Mdp::PriorityState::getModel ( )
inlineprotected

Definition at line 46 of file priorityState.h.

virtual std::string Mdp::PriorityState::getName ( )
pure virtual

returns the name of that state

Implemented in Prio.

virtual bool Mdp::PriorityState::isInState ( )
pure virtual

Given the information provided by the DomainModel, this function checks if the system is in that state.

Returns
returns true if the system is in this state, or false otherwise

Implemented in Prio.

Member Data Documentation

std::shared_ptr<DomainModel> Mdp::PriorityState::domainModel {nullptr}
protected

Definition at line 53 of file priorityState.h.


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