protocols::network::UIObserver Class Reference

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

#include <ui_mover.hh>

Inheritance diagram for protocols::network::UIObserver:

Public Types
enum class	ObserverType { general = 1 , energy = 2 , conformation = 4 , none = 0 }

Public Member Functions
	UIObserver ()
	UIObserver (UIObserver const &)
	~UIObserver () override
UIObserver &	operator= (UIObserver const &)
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)
UIMover &	ui_mover ()
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...
CacheableObserver &	operator= (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_ = ObserverType::none
UIMover	ui_
utility::signals::Link	general_event_link_
utility::signals::Link	energy_event_link_
utility::signals::Link	conformation_event_link_

Detailed Description

Special Observer which apply UIObserver if Pose is changed.

Member Enumeration Documentation

ObserverType

enum protocols::network::UIObserver::ObserverType

strong

Enumerator
general
energy
conformation
none

Constructor & Destructor Documentation

UIObserver() [1/2]

protocols::network::UIObserver::UIObserver

(

)

UIObserver() [2/2]

protocols::network::UIObserver::UIObserver

(

UIObserver const &

rval

)

~UIObserver()

protocols::network::UIObserver::~UIObserver ( )

override

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

Member Function Documentation

add_type()

void protocols::network::UIObserver::add_type

(

ObserverType

setting

)

References type_.

attach()

void protocols::network::UIObserver::attach

(

core::pose::Pose &

p

)

Attach observer to the pose object.

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

attach_impl()

void protocols::network::UIObserver::attach_impl ( core::pose::Pose &  pose )

overrideprotectedvirtual

attach to Pose/Conformation

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

References core::pose::Pose::attach_conformation_obs(), core::pose::Pose::attach_energy_obs(), core::pose::Pose::attach_general_obs(), conformation, conformation_event_link_, conformationEvent(), energy, energy_event_link_, energyEvent(), general, general_event_link_, generalEvent(), protocols::network::has_observer_of_type(), and type_.

clone()

core::pose::datacache::CacheableObserverOP protocols::network::UIObserver::clone ( )

overridevirtual

clone this object

Warning

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

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

conformationEvent()

void protocols::network::UIObserver::conformationEvent ( core::pose::signals::ConformationEvent const &  ev )

virtual

References protocols::network::UIMover::apply(), core::pose::signals::GeneralEvent::pose, and ui_.

Referenced by attach_impl().

create()

core::pose::datacache::CacheableObserverOP protocols::network::UIObserver::create ( )

overridevirtual

create a new instance of this object

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

detach()

void protocols::network::UIObserver::detach

(

core::pose::Pose &

p

)

Detach observer from the pose object.

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

detach_impl()

void protocols::network::UIObserver::detach_impl ( )

overrideprotectedvirtual

detach from Pose/Conformation

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

References conformation_event_link_, energy_event_link_, and general_event_link_.

energyEvent()

void protocols::network::UIObserver::energyEvent ( core::pose::signals::EnergyEvent const &  ev )

virtual

References protocols::network::UIMover::apply(), core::pose::signals::GeneralEvent::pose, and ui_.

Referenced by attach_impl().

generalEvent()

void protocols::network::UIObserver::generalEvent ( core::pose::signals::GeneralEvent const &  ev )

virtual

References protocols::network::UIMover::apply(), core::pose::signals::GeneralEvent::pose, and ui_.

Referenced by attach_impl().

get_type()

ObserverType protocols::network::UIObserver::get_type ( ) const

inline

References type_.

is_attached()

bool protocols::network::UIObserver::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_.

operator=()

UIObserver & protocols::network::UIObserver::operator=

(

UIObserver const &

other

)

References core::pose::datacache::CacheableObserver::operator=(), type_, and ui_.

set_type()

void protocols::network::UIObserver::set_type

(

ObserverType

setting

)

References type_.

ui_mover()

UIMover& protocols::network::UIObserver::ui_mover ( )

inline

References ui_.

update_links()

void protocols::network::UIObserver::update_links ( )

protected

Member Data Documentation

conformation_event_link_

utility::signals::Link protocols::network::UIObserver::conformation_event_link_

private

Referenced by attach_impl(), detach_impl(), and is_attached().

energy_event_link_

utility::signals::Link protocols::network::UIObserver::energy_event_link_

private

Referenced by attach_impl(), detach_impl(), and is_attached().

general_event_link_

utility::signals::Link protocols::network::UIObserver::general_event_link_

private

Referenced by attach_impl(), detach_impl(), and is_attached().

type_

ObserverType protocols::network::UIObserver::type_ = ObserverType::none

private

Referenced by add_type(), attach_impl(), get_type(), operator=(), and set_type().

ui_

UIMover protocols::network::UIObserver::ui_

private

Referenced by conformationEvent(), energyEvent(), generalEvent(), operator=(), and ui_mover().

---

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

• src/protocols/network/ui_mover.hh
• src/protocols/network/ui_mover.cc