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

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:
Inheritance graph
[legend]
Collaboration diagram for core::pose::datacache::SpecialSegmentsObserver:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
core::pose::datacache::CacheableObserver 
Parent
typedef utility::signals::Link Link
typedef core::Size Size
typedef std::pair< Size, SizeSegment

Public Member Functions

 SpecialSegmentsObserver ()
 SpecialSegmentsObserver (SpecialSegmentsObserver const &rval)
 ~SpecialSegmentsObserver ()
SpecialSegmentsObserveroperator= (SpecialSegmentsObserver const &rval)
 copy assignment
pose::datacache::CacheableObserverOP clone ()
 clone this object
pose::datacache::CacheableObserverOP create ()
 create a new instance of this object
bool is_attached () const
 is this observer attached to a Pose/Conformation?
utility::vector1< Segment > const & segments () const
void clear ()
void add_segment (Size begin, Size end)

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

Protected Member Functions

void on_length_change (conformation::signals::LengthEvent const &event)
virtual void attach_impl (pose::Pose &pose)
 attach to Pose/Conformation
virtual void detach_impl ()
 detach from Pose/Conformation

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


Member Typedef Documentation


Constructor & Destructor Documentation

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

Referenced by clone(), and create().

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

Member Function Documentation

void core::pose::datacache::SpecialSegmentsObserver::add_segment ( Size  begin,
Size  end 
)
void core::pose::datacache::SpecialSegmentsObserver::attach_impl ( pose::Pose pose) [protected, virtual]
void core::pose::datacache::SpecialSegmentsObserver::clear ( )
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.

References SpecialSegmentsObserver().

pose::datacache::CacheableObserverOP core::pose::datacache::SpecialSegmentsObserver::create ( ) [virtual]

create a new instance of this object

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

References SpecialSegmentsObserver().

void core::pose::datacache::SpecialSegmentsObserver::detach_impl ( ) [protected, virtual]

detach from Pose/Conformation

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

bool core::pose::datacache::SpecialSegmentsObserver::is_attached ( ) const [inline, virtual]

is this observer attached to a Pose/Conformation?

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

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

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

Referenced by attach_impl().

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

copy assignment

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

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 
) [static]

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