Horizon Official Technical Documentation
Horizon::System::RuntimeContextChain::ContextControlAgent Class Reference

#include <System.hpp>

Public Member Functions

bool start ()
 
bool stop ()
 
bool pause ()
 
bool cancel ()
 
bool completed ()
 
bool failed ()
 
runtime_routine_chain_status get_status ()
 

Public Attributes

std::atomic< enum runtime_routine_chain_status_status {RUNTIME_ROUTINE_CHAIN_NOT_STARTED}
 

Member Function Documentation

◆ cancel()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::cancel ( )
inline
516 {
518
520 return false;
521
523 return true;
524 }
std::atomic< enum runtime_routine_chain_status > _status
Definition: System.hpp:550
runtime_routine_chain_status get_status()
Definition: System.hpp:548
runtime_routine_chain_status
Definition: System.hpp:52
@ RUNTIME_ROUTINE_CHAIN_CANCELLED
Definition: System.hpp:58
@ RUNTIME_ROUTINE_CHAIN_STARTED
Definition: System.hpp:57

References _status, get_status(), Horizon::System::RUNTIME_ROUTINE_CHAIN_CANCELLED, and Horizon::System::RUNTIME_ROUTINE_CHAIN_STARTED.

+ Here is the call graph for this function:

◆ completed()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::completed ( )
inline
527 {
529
531 return false;
532
534 return true;
535 }
@ RUNTIME_ROUTINE_CHAIN_COMPLETED
Definition: System.hpp:59

References _status, get_status(), and Horizon::System::RUNTIME_ROUTINE_CHAIN_COMPLETED.

+ Here is the call graph for this function:

◆ failed()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::failed ( )
inline
538 {
540
541 if (status == RUNTIME_ROUTINE_CHAIN_FAILED)
542 return false;
543
545 return true;
546 }
@ RUNTIME_ROUTINE_CHAIN_FAILED
Definition: System.hpp:55

References _status, get_status(), and Horizon::System::RUNTIME_ROUTINE_CHAIN_FAILED.

+ Here is the call graph for this function:

◆ get_status()

runtime_routine_chain_status Horizon::System::RuntimeContextChain::ContextControlAgent::get_status ( )
inline
548{ return _status.load(); }

References _status.

Referenced by cancel(), completed(), failed(), pause(), start(), and stop().

+ Here is the caller graph for this function:

◆ pause()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::pause ( )
inline
505 {
507
509 return false;
510
512 return true;
513 }
@ RUNTIME_ROUTINE_CHAIN_PAUSED
Definition: System.hpp:56

References _status, get_status(), Horizon::System::RUNTIME_ROUTINE_CHAIN_COMPLETED, Horizon::System::RUNTIME_ROUTINE_CHAIN_FAILED, and Horizon::System::RUNTIME_ROUTINE_CHAIN_PAUSED.

+ Here is the call graph for this function:

◆ start()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::start ( )
inline
481 {
483
485 return false;
486
488 return true;
489 }
@ RUNTIME_ROUTINE_CHAIN_NOT_STARTED
Definition: System.hpp:53

References _status, get_status(), Horizon::System::RUNTIME_ROUTINE_CHAIN_NOT_STARTED, and Horizon::System::RUNTIME_ROUTINE_CHAIN_STARTED.

+ Here is the call graph for this function:

◆ stop()

bool Horizon::System::RuntimeContextChain::ContextControlAgent::stop ( )
inline
492 {
495
496 if (status == RUNTIME_ROUTINE_CHAIN_FAILED || status == RUNTIME_ROUTINE_CHAIN_COMPLETED || status == stop)
497 return false;
498
499 _status.store(stop);
500
501 return true;
502 }
@ RUNTIME_ROUTINE_CHAIN_STOPPED
Definition: System.hpp:54

References _status, get_status(), Horizon::System::RUNTIME_ROUTINE_CHAIN_COMPLETED, Horizon::System::RUNTIME_ROUTINE_CHAIN_FAILED, Horizon::System::RUNTIME_ROUTINE_CHAIN_STOPPED, and stop().

Referenced by stop().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ _status

std::atomic<enum runtime_routine_chain_status> Horizon::System::RuntimeContextChain::ContextControlAgent::_status {RUNTIME_ROUTINE_CHAIN_NOT_STARTED}

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