Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Functions
protocols::network Namespace Reference

Classes

struct  NetworkQueue
 
class  UIMover
 
class  UIObserver
 Special Observer which apply UIObserver if Pose is changed. More...
 

Typedefs

using StringUP = std::unique_ptr< std::string >
 
using UIMoverSP = utility::pointer::shared_ptr< UIMover >
 
using UIMoverCSP = utility::pointer::shared_ptr< UIMover const >
 
using UIMoverOP = UIMoverSP
 
using UIMoverCOP = UIMoverCSP
 
using UIObserverSP = utility::pointer::shared_ptr< UIObserver >
 
using UIObserverCSP = utility::pointer::shared_ptr< UIObserver const >
 
using UIObserverOP = UIObserverSP
 
using UIObserverCOP = UIObserverCSP
 

Functions

StringUP pose_to_string (core::pose::Pose const &pose)
 
bool is_cloud_integration_enabled ()
 estimate if it resonable to expect for Cloud integration to work with current build settings and supplied commandline options More...
 
void post_file (std::string const &file_name, std::string const &data, bool append)
 
void post_decoy (std::string const &file_name, core::pose::Pose const &pose)
 
void post_decoy (core::pose::Pose const &pose)
 
UIObserverOP get_ui_observer (core::pose::Pose &pose)
 (Internal) helper function to create a UIObserver and add it to the given pose NOTE: You NEED to adjust the observer type and call attach() on the return - by default a new UIObserver isn't attached/observing. More...
 
UIObserverOP AddUIObserver (core::pose::Pose &p)
 Helper function that create UIObserver Object and add it to the give Pose. This is the most likely the only function that you need to call... More...
 
UIObserverOP AddUIObserver_to_energies (core::pose::Pose &p)
 Helper function that create UIObserver Object and add it to the give Pose energies object so pymol only updates on energy changes. More...
 
UIObserverOP AddUIObserver_to_conformation (core::pose::Pose &p)
 Helper function that create UIObserver Object and add it to the give Pose conformation object so pymol only updates on conformation changes. More...
 
UIObserver::ObserverType operator| (UIObserver::ObserverType lhs, UIObserver::ObserverType rhs)
 
UIObserver::ObserverType operator& (UIObserver::ObserverType lhs, UIObserver::ObserverType rhs)
 
bool has_observer_of_type (UIObserver::ObserverType flag, UIObserver::ObserverType observer)
 

Typedef Documentation

using protocols::network::StringUP = typedef std::unique_ptr<std::string>
using protocols::network::UIMoverCSP = typedef utility::pointer::shared_ptr< UIMover const >
using protocols::network::UIMoverSP = typedef utility::pointer::shared_ptr< UIMover >
using protocols::network::UIObserverCSP = typedef utility::pointer::shared_ptr< UIObserver const >
using protocols::network::UIObserverSP = typedef utility::pointer::shared_ptr< UIObserver >

Function Documentation

UIObserverOP protocols::network::AddUIObserver ( core::pose::Pose p)

Helper function that create UIObserver Object and add it to the give Pose. This is the most likely the only function that you need to call...

References protocols::network::UIObserver::general, and get_ui_observer().

UIObserverOP protocols::network::AddUIObserver_to_conformation ( core::pose::Pose p)

Helper function that create UIObserver Object and add it to the give Pose conformation object so pymol only updates on conformation changes.

References protocols::network::UIObserver::conformation, and get_ui_observer().

UIObserverOP protocols::network::AddUIObserver_to_energies ( core::pose::Pose p)

Helper function that create UIObserver Object and add it to the give Pose energies object so pymol only updates on energy changes.

References protocols::network::UIObserver::energy, and get_ui_observer().

UIObserverOP protocols::network::get_ui_observer ( core::pose::Pose pose)

(Internal) helper function to create a UIObserver and add it to the given pose NOTE: You NEED to adjust the observer type and call attach() on the return - by default a new UIObserver isn't attached/observing.

References core::pose::Pose::observer_cache(), core::pose::datacache::ObserverCache::set(), and core::pose::datacache::UI_OBSERVER.

Referenced by AddUIObserver(), AddUIObserver_to_conformation(), and AddUIObserver_to_energies().

bool protocols::network::has_observer_of_type ( UIObserver::ObserverType  flag,
UIObserver::ObserverType  observer 
)
inline
bool protocols::network::is_cloud_integration_enabled ( )

estimate if it resonable to expect for Cloud integration to work with current build settings and supplied commandline options

Referenced by post_decoy(), and post_file().

UIObserver::ObserverType protocols::network::operator& ( UIObserver::ObserverType  lhs,
UIObserver::ObserverType  rhs 
)
inline
UIObserver::ObserverType protocols::network::operator| ( UIObserver::ObserverType  lhs,
UIObserver::ObserverType  rhs 
)
inline
StringUP protocols::network::pose_to_string ( core::pose::Pose const &  pose)
void protocols::network::post_decoy ( std::string const &  file_name,
core::pose::Pose const &  pose 
)
void protocols::network::post_decoy ( core::pose::Pose const &  pose)
void protocols::network::post_file ( std::string const &  file_name,
std::string const &  data,
bool  append 
)