Horizon Official Technical Documentation
Horizon::System::RuntimeRoutineContext::Work::MessageAgent Class Reference

#include <System.hpp>

+ Collaboration diagram for Horizon::System::RuntimeRoutineContext::Work::MessageAgent:

Public Member Functions

 MessageAgent (std::shared_ptr< RuntimeRoutineContext > runtime_context, Work *work)
 
 ~MessageAgent ()
 
std::shared_ptr< RuntimeRoutineContextget_runtime_context ()
 
void set_status_message (std::string message)
 
std::string get_status_message ()
 
void set_warning_message (std::string message)
 
std::string get_warning_message ()
 
void set_error_message (std::string message)
 
std::string get_error_message ()
 

Protected Attributes

std::string _status_message {""}
 
std::string _warning_message {""}
 
std::string _error_message {""}
 
std::weak_ptr< RuntimeRoutineContext_runtime_context
 
Work_work
 

Constructor & Destructor Documentation

◆ MessageAgent()

Horizon::System::RuntimeRoutineContext::Work::MessageAgent::MessageAgent ( std::shared_ptr< RuntimeRoutineContext runtime_context,
Work work 
)
inline
420 : _runtime_context(runtime_context), _work(work) { }
std::weak_ptr< RuntimeRoutineContext > _runtime_context
Definition: System.hpp:450

◆ ~MessageAgent()

Horizon::System::RuntimeRoutineContext::Work::MessageAgent::~MessageAgent ( )
inline
421{ }

Member Function Documentation

◆ get_error_message()

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::get_error_message ( )
inline
444{ return _error_message; }
std::string _error_message
Definition: System.hpp:449

References _error_message.

◆ get_runtime_context()

std::shared_ptr< RuntimeRoutineContext > Horizon::System::RuntimeRoutineContext::Work::MessageAgent::get_runtime_context ( )
inline
423{ return !_runtime_context.expired() ? _runtime_context.lock() : nullptr; }

References _runtime_context.

Referenced by set_error_message(), set_status_message(), and set_warning_message().

+ Here is the caller graph for this function:

◆ get_status_message()

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::get_status_message ( )
inline
430{return _status_message; }
std::string _status_message
Definition: System.hpp:447

References _status_message.

◆ get_warning_message()

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::get_warning_message ( )
inline
437{ return _warning_message; }
std::string _warning_message
Definition: System.hpp:448

References _warning_message.

◆ set_error_message()

void Horizon::System::RuntimeRoutineContext::Work::MessageAgent::set_error_message ( std::string  message)
inline
439 {
440 _error_message = message;
441 if (_error_message.size() > 0)
442 get_runtime_context()->error_message("{w:" + _work->get_uuid_string() + "}: " + _error_message);
443 }
std::string get_uuid_string()
Definition: System.hpp:146
std::shared_ptr< RuntimeRoutineContext > get_runtime_context()
Definition: System.hpp:423

References _error_message, _work, get_runtime_context(), and Horizon::System::RuntimeContext::WorkContext::get_uuid_string().

+ Here is the call graph for this function:

◆ set_status_message()

void Horizon::System::RuntimeRoutineContext::Work::MessageAgent::set_status_message ( std::string  message)
inline
425 {
426 _status_message = message;
427 if (_status_message.size() > 0)
428 get_runtime_context()->status_message("{w:" + _work->get_uuid_string() + "}: " + _status_message);
429 }

References _status_message, _work, get_runtime_context(), and Horizon::System::RuntimeContext::WorkContext::get_uuid_string().

+ Here is the call graph for this function:

◆ set_warning_message()

void Horizon::System::RuntimeRoutineContext::Work::MessageAgent::set_warning_message ( std::string  message)
inline
432 {
433 _warning_message = message;
434 if (_warning_message.size() > 0)
435 get_runtime_context()->warning_message("{w:" + _work->get_uuid_string() + "}: " + _warning_message);
436 }

References _warning_message, _work, get_runtime_context(), and Horizon::System::RuntimeContext::WorkContext::get_uuid_string().

+ Here is the call graph for this function:

Member Data Documentation

◆ _error_message

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::_error_message {""}
protected

◆ _runtime_context

std::weak_ptr<RuntimeRoutineContext> Horizon::System::RuntimeRoutineContext::Work::MessageAgent::_runtime_context
protected

Referenced by get_runtime_context().

◆ _status_message

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::_status_message {""}
protected

◆ _warning_message

std::string Horizon::System::RuntimeRoutineContext::Work::MessageAgent::_warning_message {""}
protected

◆ _work

Work* Horizon::System::RuntimeRoutineContext::Work::MessageAgent::_work
protected

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