ui::task Namespace Reference

Classes
struct	PNode
	struct to help represent Project as tree. This is local datatype used only by ProjectModel More...
class	ProjectModel
struct	FileID
class	File
	File node that hold concreate data with concreate file-name. More...
class	FileTableModel
class	Functor
class	FunctorSequence
	FunctorSequence is essentially a subroutine-like construct that allow you to call sequence of function one-by-one. It guarantee that the next in line function will be called only after all previous calls has finished. More...
class	FunctorASyncSequence
	FunctorASyncSequence: same as FunctorSequence but start excution of all functors at once. More...
class	FunctorNetworkCall
class	JobSubmit
class	JobView
class	Updater
class	Node
class	Project
class	ProjectTasksModel
class	ProjectView
class	Task
class	TaskCancelDialog
class	FileTableWatcher
class	TaskSubmit
class	TaskSyncer_NodeStrategy
class	TaskSyncer_TaskStrategy
class	TaskView
class	NetworkCall

Typedefs
using	PNodeSP = std::shared_ptr< PNode >
using	PNodeCSP = std::shared_ptr< PNode const >
using	FileSP = std::shared_ptr< File >
using	FileCSP = std::shared_ptr< File const >
using	FileQP = QPointer< File >
using	Files = std::set< FileSP, File::LessFileSP >
using	FunctorSP = std::shared_ptr< Functor >
using	FunctorCSP = std::shared_ptr< Functor const >
using	NodeWP = std::weak_ptr< Node >
using	NodeSP = std::shared_ptr< Node >
using	NodeCSP = std::shared_ptr< Node const >
using	ProjectSP = std::shared_ptr< Project >
using	ProjectCSP = std::shared_ptr< Project const >
using	ProjectUP = std::unique_ptr< Project >
using	TaskSP = std::shared_ptr< Task >
using	TaskCSP = std::shared_ptr< Task const >
using	TaskQP = QPointer< Task >
using	TaskWP = std::weak_ptr< Task >
using	TaskSyncer_NodeStrategyQP = QPointer< TaskSyncer_NodeStrategy >
using	TaskSyncer_NodeStrategySP = std::shared_ptr< TaskSyncer_NodeStrategy >
using	TaskSyncer_NodeStrategyCSP = std::shared_ptr< TaskSyncer_NodeStrategy const >
using	TimeStamp = int64_t

Functions
QWidget *	create_viewer_for_file (QWidget *parent, FileSP const &f)
QDataStream &	operator<< (QDataStream &out, File::Kind k)
QDataStream &	operator>> (QDataStream &in, File::Kind &k)
QDataStream &	operator<< (QDataStream &out, File const &f)
QDataStream &	operator>> (QDataStream &in, File &f)
QDataStream &	operator<< (QDataStream &out, Node const &n)
QDataStream &	operator>> (QDataStream &in, Node &n)
Node::Flags	operator& (Node::Flags lhs, Node::Flags rhs)
Node::Flags &	operator&= (Node::Flags &lhs, Node::Flags rhs)
Node::Flags	operator| (Node::Flags lhs, Node::Flags rhs)
Node::Flags &	operator|= (Node::Flags &lhs, Node::Flags rhs)
bool	has_permission (Node::Flags flag, Node::Flags permission)
QDataStream &	operator<< (QDataStream &out, Project const &p)
QDataStream &	operator>> (QDataStream &in, Project &p)
QDataStream &	operator<< (QDataStream &out, Task::Job const &j)
QDataStream &	operator>> (QDataStream &in, Task::Job &j)
QDataStream &	operator<< (QDataStream &out, Task const &t)
QDataStream &	operator>> (QDataStream &in, Task &t)
QDataStream &	operator<< (QDataStream &out, TaskSyncer_NodeStrategy const &t)
QDataStream &	operator>> (QDataStream &in, TaskSyncer_NodeStrategy &t)
QDataStream &	operator<< (QDataStream &out, TaskSyncer_TaskStrategy const &)
QDataStream &	operator>> (QDataStream &in, TaskSyncer_TaskStrategy &t)
void	open_file_viewer (FileSP const &file, TaskSP const &task, QWidget *parent)
TimeStamp	get_utc_timestamp ()
int	get_retry_interval ()
	calculate appropriate delay in sec until next network retry should be made More...
QNetworkAccessManager *	network_access_manager ()
QString	server_base_url ()
QString	server_url ()
	deprecated: basic url for Node-base API More...
QString	task_api_url ()
bool	save_project (Project &project, bool always_ask_for_file_name)
bool	check_submit_requirements (Project &project)
	Check if system have enough configuration for Task to be submitted. Right now this include credentials and file-name for project. More...

Variables
Node::Key const	_input_key_ {"input"}
Node::Key const	_output_key_ {"output"}
Node::Key const	_script_key_ {"script"}
quint32 const	_Node_stream_version_ = 0x00000001
quint32 const	_Project_stream_version_ = 0x00000001
static std::map< QString, Task::State > const	_String_to_Task_State_
quint32 const	_Task_Job_stream_version_ = 0x00000001
quint32 const	_Task_stream_version_ = 0x00000002
quint32 const	_TaskSyncer_NodeStrategy_stream_version_ = 0x00000001
quint32 const	_TaskSyncer_TaskStrategy_stream_version_ = 0x00000001

Typedef Documentation

FileCSP

using ui::task::FileCSP = typedef std::shared_ptr< File const >

FileQP

using ui::task::FileQP = typedef QPointer<File>

Files

using ui::task::Files = typedef std::set<FileSP, File::LessFileSP>

FileSP

using ui::task::FileSP = typedef std::shared_ptr< File >

FunctorCSP

using ui::task::FunctorCSP = typedef std::shared_ptr< Functor const >

FunctorSP

using ui::task::FunctorSP = typedef std::shared_ptr< Functor >

NodeCSP

using ui::task::NodeCSP = typedef std::shared_ptr< Node const >

NodeSP

using ui::task::NodeSP = typedef std::shared_ptr< Node >

NodeWP

using ui::task::NodeWP = typedef std::weak_ptr< Node >

PNodeCSP

using ui::task::PNodeCSP = typedef std::shared_ptr< PNode const >

PNodeSP

using ui::task::PNodeSP = typedef std::shared_ptr< PNode >

ProjectCSP

using ui::task::ProjectCSP = typedef std::shared_ptr< Project const >

ProjectSP

using ui::task::ProjectSP = typedef std::shared_ptr< Project >

ProjectUP

using ui::task::ProjectUP = typedef std::unique_ptr< Project >

TaskCSP

using ui::task::TaskCSP = typedef std::shared_ptr< Task const >

TaskQP

using ui::task::TaskQP = typedef QPointer<Task>

TaskSP

using ui::task::TaskSP = typedef std::shared_ptr< Task >

TaskSyncer_NodeStrategyCSP

using ui::task::TaskSyncer_NodeStrategyCSP = typedef std::shared_ptr<TaskSyncer_NodeStrategy const >

TaskSyncer_NodeStrategyQP

using ui::task::TaskSyncer_NodeStrategyQP = typedef QPointer<TaskSyncer_NodeStrategy>

TaskSyncer_NodeStrategySP

using ui::task::TaskSyncer_NodeStrategySP = typedef std::shared_ptr<TaskSyncer_NodeStrategy>

TaskWP

using ui::task::TaskWP = typedef std::weak_ptr< Task >

TimeStamp

using ui::task::TimeStamp = typedef int64_t

Function Documentation

check_submit_requirements()

bool ui::task::check_submit_requirements

(

Project &

project

)

Check if system have enough configuration for Task to be submitted. Right now this include credentials and file-name for project.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::c, ui::config::get_user_credentials(), conf::project, create_a3b_hbs::r, and save_project().

Referenced by ui::task::ProjectView::on_new_task_clicked().

create_viewer_for_file()

QWidget * ui::task::create_viewer_for_file	(	QWidget *	parent,
		FileSP const &	f
	)

References test.T009_Exceptions::e, val2thr::ext, create_a3b_hbs::f, basic::options::OptionKeys::in::file::list, beta_nonlocal::pose, pyrosetta.distributed.io::pose_from_pdbstring(), and test.T850_SubClassing::pv.

Referenced by ui::task::TaskSubmit::on_files_clicked(), and ui::task::TaskView::preview_file().

get_retry_interval()

int ui::task::get_retry_interval

(

)

calculate appropriate delay in sec until next network retry should be made

References get_utc_timestamp(), basic::options::OptionKeys::ms::checkpoint::interval, and min().

Referenced by ui::task::Node::data_upload_finished(), and ui::task::NetworkCall::network_operation_is_finished().

get_utc_timestamp()

TimeStamp ui::task::get_utc_timestamp

(

)

Referenced by ui::task::Node::data_is_fresh(), and get_retry_interval().

has_permission()

bool ui::task::has_permission ( Node::Flags  flag, Node::Flags  permission  )

inline

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::flag.

Referenced by ui::task::Node::data_is_fresh(), ui::task::Updater::update_data_ready(), and ui::task::Node::update_from_json().

network_access_manager()

QNetworkAccessManager * ui::task::network_access_manager

(

)

References enumerate_junctions::manager.

Referenced by ui::task::NetworkCall::call(), ui::task::Node::data_is_fresh(), ui::task::Node::data_is_outdated(), download_url(), and ui::task::Updater::listen_to_updates().

open_file_viewer()

void ui::task::open_file_viewer	(	FileSP const &	file,
		TaskSP const &	task,
		QWidget *	parent
	)

References bin_torsions::arguments, evaluate_beta_mutants::file, ui::config::get_pdb_viewer_path(), basic::options::process(), and vancomycin::task.

Referenced by ui::task::TaskView::action_output_open(), ui::task::TaskView::on_output_doubleClicked(), and ui::viewers::ScoreFileView::point_clicked().

operator&()

Node::Flags ui::task::operator& ( Node::Flags  lhs, Node::Flags  rhs  )

inline

References test.T110_numeric::I.

operator&=()

Node::Flags& ui::task::operator&= ( Node::Flags &  lhs, Node::Flags  rhs  )

inline

References test.T110_numeric::I.

operator<<() [1/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		File const &	f
	)

operator<<() [2/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		File::Kind	k
	)

operator<<() [3/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		Node const &	n
	)

operator<<() [4/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		Project const &	p
	)

operator<<() [5/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		Task const &	t
	)

operator<<() [6/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		Task::Job const &	j
	)

References ui::util::_Task_Job_magic_number_, _Task_Job_stream_version_, create_a3b_hbs::j, and erraser_single_res_analysis::out.

operator<<() [7/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		TaskSyncer_NodeStrategy const &	t
	)

operator<<() [8/8]

QDataStream& ui::task::operator<<	(	QDataStream &	out,
		TaskSyncer_TaskStrategy const &
	)

operator>>() [1/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		File &	f
	)

operator>>() [2/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		File::Kind &	k
	)

operator>>() [3/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		Node &	n
	)

operator>>() [4/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		Project &	p
	)

operator>>() [5/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		Task &	t
	)

operator>>() [6/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		Task::Job &	j
	)

References ui::util::_Task_Job_magic_number_, _Task_Job_stream_version_, arg(), basic::options::OptionKeys::in::in, create_a3b_hbs::j, and basic::options::OptionKeys::run::version.

operator>>() [7/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		TaskSyncer_NodeStrategy &	t
	)

operator>>() [8/8]

QDataStream& ui::task::operator>>	(	QDataStream &	in,
		TaskSyncer_TaskStrategy &	t
	)

operator|()

Node::Flags ui::task::operator| ( Node::Flags  lhs, Node::Flags  rhs  )

inline

References test.T110_numeric::I.

operator|=()

Node::Flags& ui::task::operator|= ( Node::Flags &  lhs, Node::Flags  rhs  )

inline

References test.T110_numeric::I.

save_project()

bool ui::task::save_project	(	Project &	project,
		bool	always_ask_for_file_name
	)

Try to save project. If project file name is not set then ask user for it. If always_ask_for_file_name is true - always ask for file name. return true on success

References evaluate_beta_mutants::file, erraser_single_res_analysis::out, conf::project, and tr.

Referenced by check_submit_requirements(), ui::task::TaskSyncer_NodeStrategy::draft_to_queued(), ui::task::ProjectView::on_action_save_project_as_triggered(), and ui::task::ProjectView::on_action_save_project_triggered().

server_base_url()

QString ui::task::server_base_url

(

)

Referenced by ui::task::NetworkCall::call(), server_url(), and task_api_url().

server_url()

QString ui::task::server_url

(

)

deprecated: basic url for Node-base API

References server_base_url().

Referenced by ui::task::Node::data_is_fresh(), ui::task::Node::data_is_outdated(), ui::task::Updater::listen_to_updates(), and NodeTest::test_node_upload_and_download().

task_api_url()

QString ui::task::task_api_url

(

)

References server_base_url().

Referenced by ui::task::TaskCancelDialog::run(), ui::task::TaskSyncer_TaskStrategy::subscribe(), ui::task::TaskSyncer_TaskStrategy::task_data_upload(), ui::task::TaskSyncer_TaskStrategy::task_files_upload(), ui::task::TaskSyncer_TaskStrategy::task_queuing(), ui::task::TaskSubmit::TaskSubmit(), and FunctorTest::test_task_upload().

Variable Documentation

_input_key_

Node::Key const ui::task::_input_key_ {"input"}

_Node_stream_version_

quint32 const ui::task::_Node_stream_version_ = 0x00000001

_output_key_

Node::Key const ui::task::_output_key_ {"output"}

_Project_stream_version_

quint32 const ui::task::_Project_stream_version_ = 0x00000001

_script_key_

Node::Key const ui::task::_script_key_ {"script"}

_String_to_Task_State_

std::map<QString, Task::State> const ui::task::_String_to_Task_State_

static

Initial value:

= {
  {"none",     Task::State::none},
  {"draft",    Task::State::draft},
  {"queued",   Task::State::queued},
  {"running",  Task::State::running},
  {"finished", Task::State::finished},
  {"canceled", Task::State::canceled},
  {"unknown",  Task::State::unknown},
}

Referenced by ui::task::Task::from_string(), and ui::task::Task::to_string().

_Task_Job_stream_version_

quint32 const ui::task::_Task_Job_stream_version_ = 0x00000001

Referenced by operator<<(), and operator>>().

_Task_stream_version_

quint32 const ui::task::_Task_stream_version_ = 0x00000002

_TaskSyncer_NodeStrategy_stream_version_

quint32 const ui::task::_TaskSyncer_NodeStrategy_stream_version_ = 0x00000001

_TaskSyncer_TaskStrategy_stream_version_

quint32 const ui::task::_TaskSyncer_TaskStrategy_stream_version_ = 0x00000001