Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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]

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 () override
 
SpecialSegmentsObserveroperator= (SpecialSegmentsObserver const &rval)
 copy assignment More...
 
pose::datacache::CacheableObserverOP clone () override
 clone this object More...
 
pose::datacache::CacheableObserverOP create () override
 create a new instance of this object More...
 
bool is_attached () const override
 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...
 
 ~CacheableObserver () override
 default destructor More...
 
CacheableObserveroperator= (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)
 
void attach_impl (pose::Pose &pose) override
 attach to Pose/Conformation More...
 
void detach_impl () override
 detach from Pose/Conformation More...
 

Private Attributes

utility::vector1< Segmentsegments_
 
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

Member Typedef Documentation

Constructor & Destructor Documentation

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

Member Function Documentation

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

References segments_.

void core::pose::datacache::SpecialSegmentsObserver::attach_impl ( pose::Pose pose)
overrideprotectedvirtual
void core::pose::datacache::SpecialSegmentsObserver::clear ( )

References segments_.

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

clone this object

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

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

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

create a new instance of this object

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

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

detach from Pose/Conformation

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

References length_event_link_.

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

is this observer attached to a Pose/Conformation?

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

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

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)
utility::vector1< Segment > const& core::pose::datacache::SpecialSegmentsObserver::segments ( ) const
inline

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

Member Data Documentation

Link core::pose::datacache::SpecialSegmentsObserver::length_event_link_
private
utility::vector1< Segment > core::pose::datacache::SpecialSegmentsObserver::segments_
private

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