ui::network::Bowman Class Reference

#include <bowman.h>

Inheritance diagram for ui::network::Bowman:

Classes
struct	BackEnd

Public Types
using	FunctionSignature = std::map< std::string, ArgumentCSP >
using	Functions = std::map< std::string, FunctionSignature >
using	BackEnds = std::map< std::string, BackEnd >

Signals
void	client_connected (std::string const &)
void	client_disconnected (std::string const &)
void	specification_received (std::string const &, JSON_CSP const &)
void	result_received (core::pose::PoseOP const &, JSON_CSP const &)
void	progress_data_received (core::pose::PoseOP const &, JSON_CSP const &)
void	back_ends_changed (Bowman const *)

Public Member Functions
	~Bowman ()
void	execute (core::pose::PoseCOP const &, FunctionID const &command, Arguments const &args=Arguments())
void	execute (JSON_CSP const &command, std::string back_end="")
void	abort (std::string back_end="")
	Send an abort signal to back-end, if no back-end specified then signal sent to all connected clients. More...
BackEnds const &	back_ends () const
	BackEnds access. More...
int	size () const
BackEnds::const_iterator	begin () const
BackEnds::const_iterator	end () const
void	pause (bool)
	access to various HAL options More...

Static Public Member Functions
static Bowman &	bowman ()

Private Slots
void	on_bowman_thread_specification_received (std::string const &, JSON_CSP const &)
void	on_bowman_thread_client_disconnected (std::string const &)
void	on_bowman_thread_result_received (JSON_SP const &)
void	on_bowman_thread_progress_data_received (JSON_SP const &)

Private Member Functions
	Bowman (QObject *parent=nullptr)

Private Attributes
BackEnds	back_ends_
protocols::network::HAL_Settings	hal_settings_
ui::network::BowmanThread	bowman_thread_

Detailed Description

Bowman representation in main (GUI) thread store list of currently connected hal's clients and they specifications

Member Typedef Documentation

BackEnds

using ui::network::Bowman::BackEnds = std::map<std::string, BackEnd>

Functions

using ui::network::Bowman::Functions = std::map<std::string, FunctionSignature>

FunctionSignature

using ui::network::Bowman::FunctionSignature = std::map<std::string, ArgumentCSP>

Constructor & Destructor Documentation

Bowman()

ui::network::Bowman::Bowman ( QObject *  parent = nullptr )

private

References bowman_thread_, client_connected(), ui::network::BowmanThread::client_connected(), ui::network::BowmanThread::client_disconnected(), hal_settings_, on_bowman_thread_client_disconnected(), on_bowman_thread_progress_data_received(), on_bowman_thread_result_received(), on_bowman_thread_specification_received(), ui::network::BowmanThread::progress_data_received(), ui::network::BowmanThread::result_received(), ui::network::BowmanThread::set_hal_settings(), and ui::network::BowmanThread::specification_received().

~Bowman()

ui::network::Bowman::~Bowman ( )

default

Member Function Documentation

abort()

void ui::network::Bowman::abort

(

std::string

back_end = ""

)

Send an abort signal to back-end, if no back-end specified then signal sent to all connected clients.

References ui::network::BowmanThread::abort(), compute_difference::b, back_ends_, and bowman_thread_.

Referenced by job_manager.CommandRunner::menu().

back_ends()

BackEnds const& ui::network::Bowman::back_ends ( ) const

inline

BackEnds access.

References back_ends_.

Referenced by ui::network::get_function_arguments().

back_ends_changed

void ui::network::Bowman::back_ends_changed ( Bowman const *  )

signal

Referenced by ui::network::BowmanModel::BowmanModel(), on_bowman_thread_client_disconnected(), and on_bowman_thread_specification_received().

begin()

BackEnds::const_iterator ui::network::Bowman::begin ( ) const

inline

References back_ends_.

Referenced by ui::network::BowmanModel::on_bowman_back_ends_changed().

bowman()

Bowman & ui::network::Bowman::bowman ( )

static

Only one inctance of Bowman object should exist per GUI application, use bowman() to get reference to that instance Note: you should only call this after QCoreApplication instance got constructed and before it got destroyed

---

Bowman

References compute_difference::b.

Referenced by ui::network::BowmanModel::BowmanModel().

client_connected

void ui::network::Bowman::client_connected ( std::string const &  )

signal

Referenced by Bowman().

client_disconnected

void ui::network::Bowman::client_disconnected ( std::string const &  )

signal

Referenced by on_bowman_thread_client_disconnected().

end()

BackEnds::const_iterator ui::network::Bowman::end ( ) const

inline

References back_ends_.

Referenced by ui::network::BowmanModel::on_bowman_back_ends_changed().

execute() [1/2]

void ui::network::Bowman::execute	(	core::pose::PoseCOP const &	pose,
		FunctionID const &	command,
		Arguments const &	args = Arguments()
	)

Initiate execution of given command on back_end. If given PoseOP is empty - do not add pose as an argument to command If no command.name is specified, - execute null command If no command.back_end specified, - execute of first avalible back_end

Initiate execution of given command on back_end. If no command is specified, - execute null command If no back_end specified, - execute of first avalible back_end

References a, find_lowest_scoring_relaxed_struct::args, compute_difference::b, back_ends_, execute::command, create_a3b_hbs::j, object, and beta_nonlocal::pose.

execute() [2/2]

void ui::network::Bowman::execute	(	JSON_CSP const &	command,
		std::string	back_end = ""
	)

Initiate execution of given command on back_end. If no back_end specified, - execute of first avalible back_end

References back_ends_, bowman_thread_, execute::command, and ui::network::BowmanThread::execute().

on_bowman_thread_client_disconnected

void ui::network::Bowman::on_bowman_thread_client_disconnected ( std::string const &  id )

privateslot

References back_ends_, back_ends_changed(), and client_disconnected().

Referenced by Bowman().

on_bowman_thread_progress_data_received

void ui::network::Bowman::on_bowman_thread_progress_data_received ( JSON_SP const &  _result )

privateslot

References basic::options::OptionKeys::ddg::json, beta_nonlocal::pose, and progress_data_received().

Referenced by Bowman().

on_bowman_thread_result_received

void ui::network::Bowman::on_bowman_thread_result_received ( JSON_SP const &  _result )

privateslot

References basic::options::OptionKeys::ddg::json, beta_nonlocal::pose, and result_received().

Referenced by Bowman().

on_bowman_thread_specification_received

void ui::network::Bowman::on_bowman_thread_specification_received ( std::string const &  client_id, JSON_CSP const &  specification  )

privateslot

References a, arg(), find_lowest_scoring_relaxed_struct::args, back_ends_, back_ends_changed(), ui::network::Argument::create(), create_a3b_hbs::f, basic::options::OptionKeys::ddg::json, and specification_received().

Referenced by Bowman().

pause()

void ui::network::Bowman::pause

(

bool

state

)

access to various HAL options

References bowman_thread_, hal_settings_, and ui::network::BowmanThread::set_hal_settings().

progress_data_received

void ui::network::Bowman::progress_data_received ( core::pose::PoseOP const &  , JSON_CSP const &    )

signal

Referenced by on_bowman_thread_progress_data_received().

result_received

void ui::network::Bowman::result_received ( core::pose::PoseOP const &  , JSON_CSP const &    )

signal

Referenced by on_bowman_thread_result_received().

size()

int ui::network::Bowman::size ( ) const

inline

References back_ends_.

specification_received

void ui::network::Bowman::specification_received ( std::string const &  , JSON_CSP const &    )

signal

Referenced by on_bowman_thread_specification_received().

Member Data Documentation

back_ends_

BackEnds ui::network::Bowman::back_ends_

private

Referenced by abort(), back_ends(), begin(), end(), execute(), on_bowman_thread_client_disconnected(), on_bowman_thread_specification_received(), and size().

bowman_thread_

ui::network::BowmanThread ui::network::Bowman::bowman_thread_

private

Referenced by abort(), Bowman(), execute(), and pause().

hal_settings_

protocols::network::HAL_Settings ui::network::Bowman::hal_settings_

private

Referenced by Bowman(), and pause().

---

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

• src/ui/network/bowman.h
• src/ui/network/bowman.cpp