Rosetta 3.4
Public Types | Public Member Functions | Protected Types
core::pose::datacache::ObserverCache Class Reference

A DataCache storing Pose/Conformation observers derived from core::pose::datacache::CacheableObserver. More...

#include <ObserverCache.hh>

Inheritance diagram for core::pose::datacache::ObserverCache:
Inheritance graph
[legend]
Collaboration diagram for core::pose::datacache::ObserverCache:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Super::Size Size

Public Member Functions

 ObserverCache (Size const n_slots, Pose &pose)
 constructor
virtual ~ObserverCache ()
 default destructor
ObserverCacheoperator= (ObserverCache const &rval)
 copy assignment
void clear ()
 clear all the observers
void clear (Size const slot)
 clear the observer in a selected slot
void set (Size const slot, CacheableObserverOP observer)
 store a copy of the observer in the given slot and attach it to the Pose
void set (Size const slot, CacheableObserverOP observer, bool const auto_attach)
 store a copy of the observer in the given slot
bool is_attached (Size const slot) const
 is the observer in the slot attached to the Pose?
void attach ()
 attach all stored observers to the Pose
void detach ()
 detach all observers from the Pose
void attach (Size const slot)
 attach an observer in a particular slot to the Pose
void detach (Size const slot)
 detach an observer in a particular slot to the Pose

Protected Types

typedef Super::DataOPs ObserverOPs

Detailed Description

A DataCache storing Pose/Conformation observers derived from core::pose::datacache::CacheableObserver.


Member Typedef Documentation

typedef Super::DataOPs core::pose::datacache::ObserverCache::ObserverOPs [protected]

Constructor & Destructor Documentation

core::pose::datacache::ObserverCache::ObserverCache ( Size const  n_slots,
Pose pose 
)

constructor

Parameters:
[in]n_typesThe number of slots for this ObserverCache.
[in]poseThe Pose that will be watched by the Observers in this cache.
core::pose::datacache::ObserverCache::~ObserverCache ( ) [virtual]

default destructor

References detach().


Member Function Documentation

void core::pose::datacache::ObserverCache::attach ( )

attach all stored observers to the Pose

Referenced by operator=(), and set().

void core::pose::datacache::ObserverCache::attach ( Size const  slot)

attach an observer in a particular slot to the Pose

Parameters:
[in]slotAttach the observer in this slot.
void core::pose::datacache::ObserverCache::clear ( )

clear all the observers

References detach().

Referenced by clear().

void core::pose::datacache::ObserverCache::clear ( Size const  slot)

clear the observer in a selected slot

References clear(), and detach().

void core::pose::datacache::ObserverCache::detach ( )

detach all observers from the Pose

Referenced by clear(), operator=(), set(), and ~ObserverCache().

void core::pose::datacache::ObserverCache::detach ( Size const  slot)

detach an observer in a particular slot to the Pose

Parameters:
[in]slotDetach the observer in this slot.
bool core::pose::datacache::ObserverCache::is_attached ( Size const  slot) const

is the observer in the slot attached to the Pose?

Returns:
true if attached, false if not attached or no observer exists in the slot

Referenced by operator=().

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

copy assignment

References attach(), detach(), and is_attached().

void core::pose::datacache::ObserverCache::set ( Size const  slot,
CacheableObserverOP  observer,
bool const  auto_attach 
)

store a copy of the observer in the given slot

Parameters:
[in]Theslot to use.
[in]observerThe Observer to clone() and store.
[in]auto_attachAttach the observer to the Pose?

References attach(), and detach().

void core::pose::datacache::ObserverCache::set ( Size const  slot,
CacheableObserverOP  observer 
)

store a copy of the observer in the given slot and attach it to the Pose

Parameters:
[in]Theslot to use.
[in]observerThe Observer to clone() and store.
Remarks:
this function exists to ensure the base class version is overridden

Referenced by protocols::toolbox::match_enzdes_util::get_enzdes_observer().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines