Public Member Functions | Protected Member Functions | Private Types | List of all members
core::pose::datacache::CacheableObserver Class Referenceabstract

Base class for Pose/Conformation observers that are stored in a Pose's DataCache. More...

#include <CacheableObserver.hh>

Inheritance diagram for core::pose::datacache::CacheableObserver:
Inheritance graph

Public Member Functions

 CacheableObserver ()
 default constructor More...
 CacheableObserver (CacheableObserver const &rval)
 copy constructor More...
 ~CacheableObserver () override
 default destructor More...
CacheableObserveroperator= (CacheableObserver const &rval)
 copy assignment More...
virtual CacheableObserverOP clone ()=0
 clone this object More...
virtual CacheableObserverOP create ()=0
 create a new instance of this object 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...
virtual bool is_attached () const =0
 is this observer attached to a Pose/Conformation? More...

Protected Member Functions

virtual void attach_impl (Pose &pose)=0
 attach to Pose/Conformation More...
virtual void detach_impl ()=0
 detach from Pose/Conformation More...

Private Types

typedef utility::VirtualBase Super

Detailed Description

Base class for Pose/Conformation observers that are stored in a Pose's DataCache.

Classes derived from CacheableObserver whose instances are stored inside a Pose's ObserverCache will be cloned and re-attached to the new Pose instance upon Pose copy construction/assignment. CacheableObservers should not need to attach themselves independently unless necessary – attach/detach should be done through the ObserverCache's interface. For example, the ObserverCache can attach the observer upon calling ObserverCache::set().

When deriving from this class remember that Links or pointers to subjects stored in classes are not to be copied when copy constructor/assignment is called.

Member Typedef Documentation

◆ Super

typedef utility::VirtualBase core::pose::datacache::CacheableObserver::Super

Constructor & Destructor Documentation

◆ CacheableObserver() [1/2]

core::pose::datacache::CacheableObserver::CacheableObserver ( )

default constructor

◆ CacheableObserver() [2/2]

core::pose::datacache::CacheableObserver::CacheableObserver ( CacheableObserver const &  rval)

copy constructor

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

◆ ~CacheableObserver()

core::pose::datacache::CacheableObserver::~CacheableObserver ( )

default destructor

Derived classes must remember to detach on destruction!

Member Function Documentation

◆ attach_impl()

virtual void core::pose::datacache::CacheableObserver::attach_impl ( Pose pose)
protectedpure virtual

◆ attach_to()

void core::pose::datacache::CacheableObserver::attach_to ( Pose pose)

attach to Pose/Conformation Derived classes do not overload this method – see attach_impl() instead.

References attach_impl(), and detach_from().

Referenced by protocols::moves::PyMOLObserver::attach(), and protocols::network::UIObserver::attach().

◆ clone()

virtual CacheableObserverOP core::pose::datacache::CacheableObserver::clone ( )
pure virtual

◆ create()

virtual CacheableObserverOP core::pose::datacache::CacheableObserver::create ( )
pure virtual

◆ detach_from()

void core::pose::datacache::CacheableObserver::detach_from ( )

◆ detach_impl()

virtual void core::pose::datacache::CacheableObserver::detach_impl ( )
protectedpure virtual

◆ is_attached()

virtual bool core::pose::datacache::CacheableObserver::is_attached ( ) const
pure virtual

◆ operator=()

CacheableObserver & core::pose::datacache::CacheableObserver::operator= ( CacheableObserver const &  rval)

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