core::pose::datacache::LengthEventCollector Class Reference

a cacheable observer that keeps track of what length events occured More...

#include <cacheable_observers.hh>

Inheritance diagram for core::pose::datacache::LengthEventCollector:

Collaboration diagram for core::pose::datacache::LengthEventCollector:

Public Types
typedef utility::signals::Link	Link

Public Member Functions
	LengthEventCollector ()
	default constructor More...
	LengthEventCollector (LengthEventCollector const &rval)
	copy constructor More...
	~LengthEventCollector ()
	default destructor More...
LengthEventCollector &	operator= (LengthEventCollector const &rval)
	copy assignment More...
pose::datacache::CacheableObserverOP	clone ()
	clone this object More...
pose::datacache::CacheableObserverOP	create ()
	create a new instance of this object More...
bool	is_attached () const
	is this observer attached to a Pose/Conformation? More...
void	clear_events ()
utility::vector1 < core::conformation::signals::LengthEvent > const &	events () const
Public Member Functions inherited from core::pose::datacache::CacheableObserver
	CacheableObserver ()
	default constructor More...
	CacheableObserver (CacheableObserver const &rval)
	copy constructor More...
virtual	~CacheableObserver ()
	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
virtual void	attach_impl (pose::Pose &pose)
	attach to Pose/Conformation More...
virtual void	detach_impl ()
	detach from Pose/Conformation More...
void	on_length_change (conformation::signals::LengthEvent const &event)

Private Member Functions
void	copy_length_events (utility::vector1< core::conformation::signals::LengthEvent > const &events)

Private Attributes
utility::vector1 < core::conformation::signals::LengthEvent >	length_events_
Link	length_event_link_

Detailed Description

a cacheable observer that keeps track of what length events occured

Definition at line 42 of file cacheable_observers.hh.

Member Typedef Documentation

typedef utility::signals::Link core::pose::datacache::LengthEventCollector::Link

Definition at line 48 of file cacheable_observers.hh.

Constructor & Destructor Documentation

core::pose::datacache::LengthEventCollector::LengthEventCollector

(

)

default constructor

Definition at line 44 of file cacheable_observers.cc.

References length_events_.

Referenced by clone(), and create().

core::pose::datacache::LengthEventCollector::LengthEventCollector

(

LengthEventCollector const &

rval)

copy constructor

Warning

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

Definition at line 52 of file cacheable_observers.cc.

References copy_length_events(), and length_events_.

core::pose::datacache::LengthEventCollector::~LengthEventCollector

(

)

default destructor

Remarks

detaches during destruction

Definition at line 58 of file cacheable_observers.cc.

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

Member Function Documentation

void core::pose::datacache::LengthEventCollector::attach_impl ( pose::Pose &  pose)

protectedvirtual

attach to Pose/Conformation

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

Definition at line 116 of file cacheable_observers.cc.

References core::conformation::Conformation::attach_length_obs(), core::pose::Pose::conformation(), length_event_link_, and on_length_change().

void core::pose::datacache::LengthEventCollector::clear_events ( )

inline

Definition at line 97 of file cacheable_observers.hh.

References length_events_.

pose::datacache::CacheableObserverOP core::pose::datacache::LengthEventCollector::clone ( )

virtual

clone this object

Warning

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

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

Definition at line 88 of file cacheable_observers.cc.

References LengthEventCollector().

void core::pose::datacache::LengthEventCollector::copy_length_events ( utility::vector1< core::conformation::signals::LengthEvent > const &  events)

private

Definition at line 95 of file cacheable_observers.cc.

References length_events_.

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

pose::datacache::CacheableObserverOP core::pose::datacache::LengthEventCollector::create ( )

virtual

create a new instance of this object

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

Definition at line 82 of file cacheable_observers.cc.

References LengthEventCollector().

void core::pose::datacache::LengthEventCollector::detach_impl ( )

protectedvirtual

detach from Pose/Conformation

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

Definition at line 123 of file cacheable_observers.cc.

References length_event_link_.

utility::vector1< core::conformation::signals::LengthEvent > const & core::pose::datacache::LengthEventCollector::events

(

)

const

Definition at line 76 of file cacheable_observers.cc.

References length_events_.

bool core::pose::datacache::LengthEventCollector::is_attached ( ) const

inlinevirtual

is this observer attached to a Pose/Conformation?

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

Definition at line 93 of file cacheable_observers.hh.

References length_event_link_.

void core::pose::datacache::LengthEventCollector::on_length_change ( conformation::signals::LengthEvent const &  event)

protected

all this class does is keep track of length events

Definition at line 110 of file cacheable_observers.cc.

References length_events_.

Referenced by attach_impl().

LengthEventCollector & core::pose::datacache::LengthEventCollector::operator=

(

LengthEventCollector const &

rval)

copy assignment

Warning

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

Definition at line 65 of file cacheable_observers.cc.

References copy_length_events(), length_events_, and core::pose::datacache::CacheableObserver::operator=().

Member Data Documentation

Link core::pose::datacache::LengthEventCollector::length_event_link_

private

Definition at line 127 of file cacheable_observers.hh.

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

utility::vector1< core::conformation::signals::LengthEvent > core::pose::datacache::LengthEventCollector::length_events_

private

Definition at line 125 of file cacheable_observers.hh.

Referenced by clear_events(), copy_length_events(), events(), LengthEventCollector(), on_length_change(), and operator=().

---

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

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