core::pose::datacache::CacheableObserver Class Reference

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:

Collaboration diagram for core::pose::datacache::CacheableObserver:

Public Member Functions
	CacheableObserver ()
	default constructor More...
	CacheableObserver (CacheableObserver const &rval)
	copy constructor More...
virtual	~CacheableObserver ()
	default destructor More...
CacheableObserver &	operator= (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::pointer::ReferenceCount	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().

Warning

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.

Definition at line 48 of file CacheableObserver.hh.

Member Typedef Documentation

typedef utility::pointer::ReferenceCount core::pose::datacache::CacheableObserver::Super

private

Definition at line 54 of file CacheableObserver.hh.

Constructor & Destructor Documentation

core::pose::datacache::CacheableObserver::CacheableObserver

(

)

default constructor

Definition at line 28 of file CacheableObserver.cc.

core::pose::datacache::CacheableObserver::CacheableObserver

(

CacheableObserver const &

rval)

copy constructor

Warning

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

Definition at line 34 of file CacheableObserver.cc.

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

virtual

default destructor

Warning

Derived classes must remember to detach on destruction!

Definition at line 41 of file CacheableObserver.cc.

Member Function Documentation

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

protectedpure virtual

attach to Pose/Conformation

Implemented in core::pose::datacache::SpecialSegmentsObserver, core::pose::datacache::LengthEventCollector, and protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver.

Referenced by 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.

Definition at line 58 of file CacheableObserver.cc.

References attach_impl(), and detach_from().

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

pure virtual

clone this object

Warning

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

Implemented in core::pose::datacache::SpecialSegmentsObserver, core::pose::datacache::LengthEventCollector, and protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver.

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

pure virtual

create a new instance of this object

Implemented in core::pose::datacache::SpecialSegmentsObserver, core::pose::datacache::LengthEventCollector, and protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver.

void core::pose::datacache::CacheableObserver::detach_from

(

)

detach from Pose/Conformation

Remarks

Derived classes do not overload this method – see detach_impl() instead.

Definition at line 67 of file CacheableObserver.cc.

References detach_impl().

Referenced by attach_to(), core::pose::datacache::LengthEventCollector::~LengthEventCollector(), and core::pose::datacache::SpecialSegmentsObserver::~SpecialSegmentsObserver().

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

protectedpure virtual

detach from Pose/Conformation

Implemented in core::pose::datacache::SpecialSegmentsObserver, core::pose::datacache::LengthEventCollector, and protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver.

Referenced by detach_from().

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

pure virtual

is this observer attached to a Pose/Conformation?

Implemented in core::pose::datacache::SpecialSegmentsObserver, core::pose::datacache::LengthEventCollector, and protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver.

CacheableObserver & core::pose::datacache::CacheableObserver::operator=

(

CacheableObserver const &

rval)

copy assignment

Warning

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

Definition at line 46 of file CacheableObserver.cc.

Referenced by core::pose::datacache::LengthEventCollector::operator=(), and core::pose::datacache::SpecialSegmentsObserver::operator=().

---

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

• src/core/pose/datacache/CacheableObserver.hh
• src/core/pose/datacache/CacheableObserver.cc