observer that tracks the fate of a one or more segments (i.e. pose residues) of interest. note: the convention should be that a segment.second marks the end of the segment but is not part of it, i.e. the last position of a segment is segment.second - 1 reason: some peculiar stuff regarding the meaning of length events More...

#include <cacheable_observers.hh>

Inheritance diagram for core::pose::datacache::SpecialSegmentsObserver:

[legend]

Collaboration diagram for core::pose::datacache::SpecialSegmentsObserver:

[legend]

Public Types
typedef core::pose::datacache::CacheableObserver	Parent

typedef utility::signals::Link	Link

typedef core::Size	Size

typedef std::pair< Size, Size >	Segment

Public Member Functions
	SpecialSegmentsObserver ()

	SpecialSegmentsObserver (SpecialSegmentsObserver const &rval)

	~SpecialSegmentsObserver ()

SpecialSegmentsObserver &	operator= (SpecialSegmentsObserver 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...

utility::vector1< Segment > const &	segments () const

void	clear ()

void	add_segment (Size begin, Size end)

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

Static Public Member Functions
static void	set_farray_from_sso (ObjexxFCL::FArray1D_bool &array, core::pose::Pose const &pose, bool const value)
	utility function that sets all elements found in the SpecialSegmentsObserver in the pose to value More...

Protected Member Functions
void	on_length_change (conformation::signals::LengthEvent const &event)

virtual void	attach_impl (pose::Pose &pose)
	attach to Pose/Conformation More...

virtual void	detach_impl ()
	detach from Pose/Conformation More...

Private Attributes
utility::vector1< Segment >	segments_

Link	length_event_link_

Detailed Description

observer that tracks the fate of a one or more segments (i.e. pose residues) of interest. note: the convention should be that a segment.second marks the end of the segment but is not part of it, i.e. the last position of a segment is segment.second - 1 reason: some peculiar stuff regarding the meaning of length events

Definition at line 137 of file cacheable_observers.hh.

Member Typedef Documentation

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

Definition at line 141 of file cacheable_observers.hh.

typedef core::pose::datacache::CacheableObserver core::pose::datacache::SpecialSegmentsObserver::Parent

Definition at line 140 of file cacheable_observers.hh.

typedef std::pair< Size, Size > core::pose::datacache::SpecialSegmentsObserver::Segment

Definition at line 143 of file cacheable_observers.hh.

typedef core::Size core::pose::datacache::SpecialSegmentsObserver::Size

Definition at line 142 of file cacheable_observers.hh.

Constructor & Destructor Documentation

core::pose::datacache::SpecialSegmentsObserver::SpecialSegmentsObserver ( )

Definition at line 130 of file cacheable_observers.cc.

Referenced by clone(), and create().

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

Definition at line 133 of file cacheable_observers.cc.

core::pose::datacache::SpecialSegmentsObserver::~SpecialSegmentsObserver ( )

Definition at line 136 of file cacheable_observers.cc.

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

Member Function Documentation

void core::pose::datacache::SpecialSegmentsObserver::add_segment	(	Size	begin,
		Size	end
	)

Definition at line 170 of file cacheable_observers.cc.

References segments_.

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

protectedvirtual

attach to Pose/Conformation

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

Definition at line 269 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::SpecialSegmentsObserver::clear ( )

Definition at line 164 of file cacheable_observers.cc.

References segments_.

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

virtual

clone this object

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

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

Definition at line 158 of file cacheable_observers.cc.

References SpecialSegmentsObserver().

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

virtual

create a new instance of this object

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

Definition at line 152 of file cacheable_observers.cc.

References SpecialSegmentsObserver().

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

protectedvirtual

detach from Pose/Conformation

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

Definition at line 276 of file cacheable_observers.cc.

References length_event_link_.

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

inlinevirtual

is this observer attached to a Pose/Conformation?

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

Definition at line 165 of file cacheable_observers.hh.

References length_event_link_.

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

protected

figure out where the loops are after the length has changed note: in case the segment got deleted, it will also be removed from the observer

Definition at line 202 of file cacheable_observers.cc.

References core::conformation::signals::LengthEvent::length_change, core::conformation::signals::LengthEvent::position, and segments_.

Referenced by attach_impl().

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

copy assignment

Definition at line 141 of file cacheable_observers.cc.

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

utility::vector1< Segment > const& core::pose::datacache::SpecialSegmentsObserver::segments ( ) const

inline

Definition at line 169 of file cacheable_observers.hh.

References segments_.

Referenced by set_farray_from_sso().

void core::pose::datacache::SpecialSegmentsObserver::set_farray_from_sso	(	ObjexxFCL::FArray1D_bool &	array,
		core::pose::Pose const &	pose,
		bool const	value
	)