Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::moves::PyMOLObserver Class Reference

Special Observer which apply PyMOLMover if Pose is changed. More...

#include <PyMOLMover.hh>

Inheritance diagram for protocols::moves::PyMOLObserver:
Inheritance graph
[legend]

Public Types

enum  ObserverType { no_observer = 0, general_observer = 1, energy_observer = 2, conformation_observer = 4 }
 

Public Member Functions

 PyMOLObserver ()
 
 PyMOLObserver (PyMOLObserver const &rval)
 
 ~PyMOLObserver () override
 
PyMOLObserveroperator= (PyMOLObserver const &rval)
 
core::pose::datacache::CacheableObserverOP clone () override
 clone this object More...
 
core::pose::datacache::CacheableObserverOP create () override
 create a new instance of this object More...
 
void set_type (ObserverType setting)
 
void add_type (ObserverType setting)
 
ObserverType get_type () const
 
bool is_attached () const override
 is this observer attached to a Pose/Conformation? More...
 
virtual void generalEvent (core::pose::signals::GeneralEvent const &ev)
 
virtual void energyEvent (core::pose::signals::EnergyEvent const &ev)
 
virtual void conformationEvent (core::pose::signals::ConformationEvent const &ev)
 
PyMOLMoverpymol ()
 
void attach (core::pose::Pose &p)
 Attach observer to the pose object. More...
 
void detach (core::pose::Pose &p)
 Detach observer from the pose object. More...
 
- Public Member Functions inherited from core::pose::datacache::CacheableObserver
 CacheableObserver ()
 default constructor More...
 
 CacheableObserver (CacheableObserver const &rval)
 copy constructor More...
 
 ~CacheableObserver () override
 default destructor More...
 
CacheableObserveroperator= (CacheableObserver const &rval)
 copy assignment More...
 
void attach_to (Pose &pose)
 attach to Pose/Conformation Derived classes do not overload this method – see attach_impl() instead. More...
 
void detach_from ()
 detach from Pose/Conformation More...
 

Protected Member Functions

void attach_impl (core::pose::Pose &pose) override
 attach to Pose/Conformation More...
 
void detach_impl () override
 detach from Pose/Conformation More...
 
void update_links ()
 

Private Attributes

ObserverType type_
 
PyMOLMover pymol_
 
utility::signals::Link general_event_link_
 
utility::signals::Link energy_event_link_
 
utility::signals::Link conformation_event_link_
 

Detailed Description

Special Observer which apply PyMOLMover if Pose is changed.

Member Enumeration Documentation

Enumerator
no_observer 
general_observer 
energy_observer 
conformation_observer 

Constructor & Destructor Documentation

protocols::moves::PyMOLObserver::PyMOLObserver ( )
protocols::moves::PyMOLObserver::PyMOLObserver ( PyMOLObserver const &  rval)
protocols::moves::PyMOLObserver::~PyMOLObserver ( )
override

Member Function Documentation

void protocols::moves::PyMOLObserver::add_type ( ObserverType  setting)

References type_.

void protocols::moves::PyMOLObserver::attach ( core::pose::Pose p)

Attach observer to the pose object.

References core::pose::datacache::CacheableObserver::attach_to().

void protocols::moves::PyMOLObserver::attach_impl ( core::pose::Pose pose)
overrideprotectedvirtual
core::pose::datacache::CacheableObserverOP protocols::moves::PyMOLObserver::clone ( )
overridevirtual

clone this object

Warning
Subject (represented by Link/pointer) is not copied!

Implements core::pose::datacache::CacheableObserver.

virtual void protocols::moves::PyMOLObserver::conformationEvent ( core::pose::signals::ConformationEvent const &  ev)
inlinevirtual
core::pose::datacache::CacheableObserverOP protocols::moves::PyMOLObserver::create ( )
overridevirtual

create a new instance of this object

Implements core::pose::datacache::CacheableObserver.

void protocols::moves::PyMOLObserver::detach ( core::pose::Pose p)

Detach observer from the pose object.

References core::pose::datacache::CacheableObserver::detach_from().

void protocols::moves::PyMOLObserver::detach_impl ( )
overrideprotectedvirtual
virtual void protocols::moves::PyMOLObserver::energyEvent ( core::pose::signals::EnergyEvent const &  ev)
inlinevirtual
virtual void protocols::moves::PyMOLObserver::generalEvent ( core::pose::signals::GeneralEvent const &  ev)
inlinevirtual
ObserverType protocols::moves::PyMOLObserver::get_type ( ) const
inline

References type_.

bool protocols::moves::PyMOLObserver::is_attached ( ) const
overridevirtual

is this observer attached to a Pose/Conformation?

Implements core::pose::datacache::CacheableObserver.

References conformation_event_link_, energy_event_link_, and general_event_link_.

PyMOLObserver & protocols::moves::PyMOLObserver::operator= ( PyMOLObserver const &  rval)
PyMOLMover& protocols::moves::PyMOLObserver::pymol ( )
inline

References pymol_.

void protocols::moves::PyMOLObserver::set_type ( ObserverType  setting)

References type_.

void protocols::moves::PyMOLObserver::update_links ( )
protected

Member Data Documentation

utility::signals::Link protocols::moves::PyMOLObserver::conformation_event_link_
private
utility::signals::Link protocols::moves::PyMOLObserver::energy_event_link_
private
utility::signals::Link protocols::moves::PyMOLObserver::general_event_link_
private
PyMOLMover protocols::moves::PyMOLObserver::pymol_
private
ObserverType protocols::moves::PyMOLObserver::type_
private

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