Rosetta: 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:

Inheritance graph

Public Member Functions
	CacheableObserver ()
	default constructor More...

	CacheableObserver (CacheableObserver const &rval)
	copy constructor More...

	~CacheableObserver () override
	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::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().

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.

Member Typedef Documentation

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

private

Constructor & Destructor Documentation

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

default constructor

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

default

copy constructor

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

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

overridedefault

default destructor

Warning: Derived classes must remember to detach on destruction!

Member Function Documentation

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

protectedpure virtual

attach to Pose/Conformation

Implemented in protocols::moves::PyMOLObserver, core::pose::datacache::SpecialSegmentsObserver, protocols::network::UIObserver, core::pose::datacache::LengthEventCollector, protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver, and protocols::denovo_design::components::StructureDataObserver.

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.

References attach_impl(), and detach_from().

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

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

pure virtual

clone this object

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

Implemented in protocols::moves::PyMOLObserver, core::pose::datacache::SpecialSegmentsObserver, protocols::network::UIObserver, core::pose::datacache::LengthEventCollector, protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver, and protocols::denovo_design::components::StructureDataObserver.

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

pure virtual

create a new instance of this object

Implemented in protocols::moves::PyMOLObserver, core::pose::datacache::SpecialSegmentsObserver, protocols::network::UIObserver, core::pose::datacache::LengthEventCollector, protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver, and protocols::denovo_design::components::StructureDataObserver.

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

detach from Pose/Conformation

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

References detach_impl().

Referenced by attach_to(), protocols::network::UIObserver::detach(), protocols::moves::PyMOLObserver::detach(), core::pose::datacache::LengthEventCollector::~LengthEventCollector(), protocols::moves::PyMOLObserver::~PyMOLObserver(), core::pose::datacache::SpecialSegmentsObserver::~SpecialSegmentsObserver(), protocols::denovo_design::components::StructureDataObserver::~StructureDataObserver(), and protocols::network::UIObserver::~UIObserver().

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

protectedpure virtual

detach from Pose/Conformation

Implemented in protocols::moves::PyMOLObserver, core::pose::datacache::SpecialSegmentsObserver, protocols::network::UIObserver, core::pose::datacache::LengthEventCollector, protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver, and protocols::denovo_design::components::StructureDataObserver.

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 protocols::moves::PyMOLObserver, core::pose::datacache::SpecialSegmentsObserver, protocols::network::UIObserver, core::pose::datacache::LengthEventCollector, protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver, and protocols::denovo_design::components::StructureDataObserver.

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

copy assignment

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

Referenced by core::pose::datacache::LengthEventCollector::operator=(), protocols::network::UIObserver::operator=(), core::pose::datacache::SpecialSegmentsObserver::operator=(), and protocols::moves::PyMOLObserver::operator=().

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

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