datacache

Bindings for core::pose::datacache namespace

class pyrosetta.rosetta.core.pose.datacache.CacheableDataType

Bases: pybind11_object

APPROXIMATE_UNSAT_POSE_INFO = <Enum.APPROXIMATE_UNSAT_POSE_INFO: 60>

ARBITRARY_FLOAT_DATA = <Enum.ARBITRARY_FLOAT_DATA: 2>

ARBITRARY_STRING_DATA = <Enum.ARBITRARY_STRING_DATA: 3>

BASE_PARTNER = <Enum.BASE_PARTNER: 21>

CDR_CLUSTER_INFO = <Enum.CDR_CLUSTER_INFO: 16>

CEN_LIST_INFO = <Enum.CEN_LIST_INFO: 22>

CHEMICAL_SHIFT_ANISOTROPY_DATA = <Enum.CHEMICAL_SHIFT_ANISOTROPY_DATA: 38>

CONSTRAINT_GENERATOR = <Enum.CONSTRAINT_GENERATOR: 10>

DAB_SASA_POSE_INFO = <Enum.DAB_SASA_POSE_INFO: 36>

DAB_SEV_POSE_INFO = <Enum.DAB_SEV_POSE_INFO: 37>

DEPC_MS_SASA_POSE_INFO = <Enum.DEPC_MS_SASA_POSE_INFO: 65>

EPR_DEER_DATA = <Enum.EPR_DEER_DATA: 64>

class Enum

Bases: pybind11_object

enum indexing the data types stored in a Pose’s internal DataCache

Members:

JOBDIST_OUTPUT_TAG

ARBITRARY_FLOAT_DATA

ARBITRARY_STRING_DATA

SIMPLE_METRIC_DATA

STRING_MAP

SCORE_LINE_STRINGS

SCORE_MAP

STM_STORED_TASKS

STORED_RESIDUE_SUBSET

CONSTRAINT_GENERATOR

POSE_BEFORE_CAVITIES_ADDED

TEMPLATE_HYBRIDIZATION_HISTORY

NCS_RESIDUE_MAPPING

FULL_MODEL_INFO

VDW_REP_SCREEN_INFO

CDR_CLUSTER_INFO

NATIVE_ANTIBODY_SEQ

WRITEABLE_DATA

POSITION_CONSERVED_RESIDUES

INTERFACE_DDG_MUTATION

BASE_PARTNER

CEN_LIST_INFO

SIGMOID_WEIGHTED_CEN_LIST

SIGMOID_WEIGHTED_D_CEN_LIST

RG_MINDATA

RG_LOCAL_MINDATA

MEMBRANE_TOPOLOGY

MEMBRANE_EMBED

INTERFACE_INFO

SS_INFO

SS_KILLHAIRPINS_INFO

RNA_SCORING_INFO

RNA_SECSTRUCT_INFO

WATER_PACKING_INFO

HOLES_POSE_INFO

DAB_SASA_POSE_INFO

DAB_SEV_POSE_INFO

CHEMICAL_SHIFT_ANISOTROPY_DATA

RESIDUAL_DIPOLAR_COUPLING_DATA

RESIDUAL_DIPOLAR_COUPLING_DATA_ROHL

RESIDUAL_DIPOLAR_COUPLING_SEGMENTS_DATA

FIBER_DIFFRACTION_CEN_SCATTERING

FIBER_DIFFRACTION_FA_SCATTERING

PSEUDOCONTACT_SHIFT_DATA

TS1_PSEUDOCONTACT_SHIFT_DATA

TS2_PSEUDOCONTACT_SHIFT_DATA

TS3_PSEUDOCONTACT_SHIFT_DATA

TS4_PSEUDOCONTACT_SHIFT_DATA

PSEUDOCONTACT_SHIFT_MULTI_DATA

GEN_BORN_POSE_INFO

MULTIPOLE_POSE_INFO

VDWTINKER_POSE_INFO

FACTS_POSE_INFO

MEMBRANE_FAEMBED

LK_BALL_POSE_INFO

PB_LIFETIME_CACHE

FAELEC_CONTEXT_DATA

GEN_BONDED_EXCL_INFO

POSE_SEQUENCE

APPROXIMATE_UNSAT_POSE_INFO

NMR_PCS_DATA

NMR_RDC_DATA

NMR_PRE_DATA

EPR_DEER_DATA

DEPC_MS_SASA_POSE_INFO

dummy_cacheable_data_type

num_cacheable_data_types

APPROXIMATE_UNSAT_POSE_INFO = <Enum.APPROXIMATE_UNSAT_POSE_INFO: 60>

ARBITRARY_FLOAT_DATA = <Enum.ARBITRARY_FLOAT_DATA: 2>

ARBITRARY_STRING_DATA = <Enum.ARBITRARY_STRING_DATA: 3>

BASE_PARTNER = <Enum.BASE_PARTNER: 21>

CDR_CLUSTER_INFO = <Enum.CDR_CLUSTER_INFO: 16>

CEN_LIST_INFO = <Enum.CEN_LIST_INFO: 22>

CHEMICAL_SHIFT_ANISOTROPY_DATA = <Enum.CHEMICAL_SHIFT_ANISOTROPY_DATA: 38>

CONSTRAINT_GENERATOR = <Enum.CONSTRAINT_GENERATOR: 10>

DAB_SASA_POSE_INFO = <Enum.DAB_SASA_POSE_INFO: 36>

DAB_SEV_POSE_INFO = <Enum.DAB_SEV_POSE_INFO: 37>

DEPC_MS_SASA_POSE_INFO = <Enum.DEPC_MS_SASA_POSE_INFO: 65>

EPR_DEER_DATA = <Enum.EPR_DEER_DATA: 64>

FACTS_POSE_INFO = <Enum.FACTS_POSE_INFO: 53>

FAELEC_CONTEXT_DATA = <Enum.FAELEC_CONTEXT_DATA: 57>

FIBER_DIFFRACTION_CEN_SCATTERING = <Enum.FIBER_DIFFRACTION_CEN_SCATTERING: 42>

FIBER_DIFFRACTION_FA_SCATTERING = <Enum.FIBER_DIFFRACTION_FA_SCATTERING: 43>

FULL_MODEL_INFO = <Enum.FULL_MODEL_INFO: 14>

GEN_BONDED_EXCL_INFO = <Enum.GEN_BONDED_EXCL_INFO: 58>

GEN_BORN_POSE_INFO = <Enum.GEN_BORN_POSE_INFO: 50>

HOLES_POSE_INFO = <Enum.HOLES_POSE_INFO: 35>

INTERFACE_DDG_MUTATION = <Enum.INTERFACE_DDG_MUTATION: 20>

INTERFACE_INFO = <Enum.INTERFACE_INFO: 29>

JOBDIST_OUTPUT_TAG = <Enum.JOBDIST_OUTPUT_TAG: 1>

LK_BALL_POSE_INFO = <Enum.LK_BALL_POSE_INFO: 55>

MEMBRANE_EMBED = <Enum.MEMBRANE_EMBED: 28>

MEMBRANE_FAEMBED = <Enum.MEMBRANE_FAEMBED: 54>

MEMBRANE_TOPOLOGY = <Enum.MEMBRANE_TOPOLOGY: 27>

MULTIPOLE_POSE_INFO = <Enum.MULTIPOLE_POSE_INFO: 51>

NATIVE_ANTIBODY_SEQ = <Enum.NATIVE_ANTIBODY_SEQ: 17>

NCS_RESIDUE_MAPPING = <Enum.NCS_RESIDUE_MAPPING: 13>

NMR_PCS_DATA = <Enum.NMR_PCS_DATA: 61>

NMR_PRE_DATA = <Enum.NMR_PRE_DATA: 63>

NMR_RDC_DATA = <Enum.NMR_RDC_DATA: 62>

PB_LIFETIME_CACHE = <Enum.PB_LIFETIME_CACHE: 56>

POSE_BEFORE_CAVITIES_ADDED = <Enum.POSE_BEFORE_CAVITIES_ADDED: 11>

POSE_SEQUENCE = <Enum.POSE_SEQUENCE: 59>

POSITION_CONSERVED_RESIDUES = <Enum.POSITION_CONSERVED_RESIDUES: 19>

PSEUDOCONTACT_SHIFT_DATA = <Enum.PSEUDOCONTACT_SHIFT_DATA: 44>

PSEUDOCONTACT_SHIFT_MULTI_DATA = <Enum.PSEUDOCONTACT_SHIFT_MULTI_DATA: 49>

RESIDUAL_DIPOLAR_COUPLING_DATA = <Enum.RESIDUAL_DIPOLAR_COUPLING_DATA: 39>

RESIDUAL_DIPOLAR_COUPLING_DATA_ROHL = <Enum.RESIDUAL_DIPOLAR_COUPLING_DATA_ROHL: 40>

RESIDUAL_DIPOLAR_COUPLING_SEGMENTS_DATA = <Enum.RESIDUAL_DIPOLAR_COUPLING_SEGMENTS_DATA: 41>

RG_LOCAL_MINDATA = <Enum.RG_LOCAL_MINDATA: 26>

RG_MINDATA = <Enum.RG_MINDATA: 25>

RNA_SCORING_INFO = <Enum.RNA_SCORING_INFO: 32>

RNA_SECSTRUCT_INFO = <Enum.RNA_SECSTRUCT_INFO: 33>

SCORE_LINE_STRINGS = <Enum.SCORE_LINE_STRINGS: 6>

SCORE_MAP = <Enum.SCORE_MAP: 7>

SIGMOID_WEIGHTED_CEN_LIST = <Enum.SIGMOID_WEIGHTED_CEN_LIST: 23>

SIGMOID_WEIGHTED_D_CEN_LIST = <Enum.SIGMOID_WEIGHTED_D_CEN_LIST: 24>

SIMPLE_METRIC_DATA = <Enum.SIMPLE_METRIC_DATA: 4>

SS_INFO = <Enum.SS_INFO: 30>

SS_KILLHAIRPINS_INFO = <Enum.SS_KILLHAIRPINS_INFO: 31>

STM_STORED_TASKS = <Enum.STM_STORED_TASKS: 8>

STORED_RESIDUE_SUBSET = <Enum.STORED_RESIDUE_SUBSET: 9>

STRING_MAP = <Enum.STRING_MAP: 5>

TEMPLATE_HYBRIDIZATION_HISTORY = <Enum.TEMPLATE_HYBRIDIZATION_HISTORY: 12>

TS1_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS1_PSEUDOCONTACT_SHIFT_DATA: 45>

TS2_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS2_PSEUDOCONTACT_SHIFT_DATA: 46>

TS3_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS3_PSEUDOCONTACT_SHIFT_DATA: 47>

TS4_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS4_PSEUDOCONTACT_SHIFT_DATA: 48>

VDWTINKER_POSE_INFO = <Enum.VDWTINKER_POSE_INFO: 52>

VDW_REP_SCREEN_INFO = <Enum.VDW_REP_SCREEN_INFO: 15>

WATER_PACKING_INFO = <Enum.WATER_PACKING_INFO: 34>

WRITEABLE_DATA = <Enum.WRITEABLE_DATA: 18>

dummy_cacheable_data_type = <Enum.dummy_cacheable_data_type: 66>

property name

num_cacheable_data_types = <Enum.DEPC_MS_SASA_POSE_INFO: 65>

property value

FACTS_POSE_INFO = <Enum.FACTS_POSE_INFO: 53>

FAELEC_CONTEXT_DATA = <Enum.FAELEC_CONTEXT_DATA: 57>

FIBER_DIFFRACTION_CEN_SCATTERING = <Enum.FIBER_DIFFRACTION_CEN_SCATTERING: 42>

FIBER_DIFFRACTION_FA_SCATTERING = <Enum.FIBER_DIFFRACTION_FA_SCATTERING: 43>

FULL_MODEL_INFO = <Enum.FULL_MODEL_INFO: 14>

GEN_BONDED_EXCL_INFO = <Enum.GEN_BONDED_EXCL_INFO: 58>

GEN_BORN_POSE_INFO = <Enum.GEN_BORN_POSE_INFO: 50>

HOLES_POSE_INFO = <Enum.HOLES_POSE_INFO: 35>

INTERFACE_DDG_MUTATION = <Enum.INTERFACE_DDG_MUTATION: 20>

INTERFACE_INFO = <Enum.INTERFACE_INFO: 29>

JOBDIST_OUTPUT_TAG = <Enum.JOBDIST_OUTPUT_TAG: 1>

LK_BALL_POSE_INFO = <Enum.LK_BALL_POSE_INFO: 55>

MEMBRANE_EMBED = <Enum.MEMBRANE_EMBED: 28>

MEMBRANE_FAEMBED = <Enum.MEMBRANE_FAEMBED: 54>

MEMBRANE_TOPOLOGY = <Enum.MEMBRANE_TOPOLOGY: 27>

MULTIPOLE_POSE_INFO = <Enum.MULTIPOLE_POSE_INFO: 51>

NATIVE_ANTIBODY_SEQ = <Enum.NATIVE_ANTIBODY_SEQ: 17>

NCS_RESIDUE_MAPPING = <Enum.NCS_RESIDUE_MAPPING: 13>

NMR_PCS_DATA = <Enum.NMR_PCS_DATA: 61>

NMR_PRE_DATA = <Enum.NMR_PRE_DATA: 63>

NMR_RDC_DATA = <Enum.NMR_RDC_DATA: 62>

PB_LIFETIME_CACHE = <Enum.PB_LIFETIME_CACHE: 56>

POSE_BEFORE_CAVITIES_ADDED = <Enum.POSE_BEFORE_CAVITIES_ADDED: 11>

POSE_SEQUENCE = <Enum.POSE_SEQUENCE: 59>

POSITION_CONSERVED_RESIDUES = <Enum.POSITION_CONSERVED_RESIDUES: 19>

PSEUDOCONTACT_SHIFT_DATA = <Enum.PSEUDOCONTACT_SHIFT_DATA: 44>

PSEUDOCONTACT_SHIFT_MULTI_DATA = <Enum.PSEUDOCONTACT_SHIFT_MULTI_DATA: 49>

RESIDUAL_DIPOLAR_COUPLING_DATA = <Enum.RESIDUAL_DIPOLAR_COUPLING_DATA: 39>

RESIDUAL_DIPOLAR_COUPLING_DATA_ROHL = <Enum.RESIDUAL_DIPOLAR_COUPLING_DATA_ROHL: 40>

RESIDUAL_DIPOLAR_COUPLING_SEGMENTS_DATA = <Enum.RESIDUAL_DIPOLAR_COUPLING_SEGMENTS_DATA: 41>

RG_LOCAL_MINDATA = <Enum.RG_LOCAL_MINDATA: 26>

RG_MINDATA = <Enum.RG_MINDATA: 25>

RNA_SCORING_INFO = <Enum.RNA_SCORING_INFO: 32>

RNA_SECSTRUCT_INFO = <Enum.RNA_SECSTRUCT_INFO: 33>

SCORE_LINE_STRINGS = <Enum.SCORE_LINE_STRINGS: 6>

SCORE_MAP = <Enum.SCORE_MAP: 7>

SIGMOID_WEIGHTED_CEN_LIST = <Enum.SIGMOID_WEIGHTED_CEN_LIST: 23>

SIGMOID_WEIGHTED_D_CEN_LIST = <Enum.SIGMOID_WEIGHTED_D_CEN_LIST: 24>

SIMPLE_METRIC_DATA = <Enum.SIMPLE_METRIC_DATA: 4>

SS_INFO = <Enum.SS_INFO: 30>

SS_KILLHAIRPINS_INFO = <Enum.SS_KILLHAIRPINS_INFO: 31>

STM_STORED_TASKS = <Enum.STM_STORED_TASKS: 8>

STORED_RESIDUE_SUBSET = <Enum.STORED_RESIDUE_SUBSET: 9>

STRING_MAP = <Enum.STRING_MAP: 5>

TEMPLATE_HYBRIDIZATION_HISTORY = <Enum.TEMPLATE_HYBRIDIZATION_HISTORY: 12>

TS1_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS1_PSEUDOCONTACT_SHIFT_DATA: 45>

TS2_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS2_PSEUDOCONTACT_SHIFT_DATA: 46>

TS3_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS3_PSEUDOCONTACT_SHIFT_DATA: 47>

TS4_PSEUDOCONTACT_SHIFT_DATA = <Enum.TS4_PSEUDOCONTACT_SHIFT_DATA: 48>

VDWTINKER_POSE_INFO = <Enum.VDWTINKER_POSE_INFO: 52>

VDW_REP_SCREEN_INFO = <Enum.VDW_REP_SCREEN_INFO: 15>

WATER_PACKING_INFO = <Enum.WATER_PACKING_INFO: 34>

WRITEABLE_DATA = <Enum.WRITEABLE_DATA: 18>

dummy_cacheable_data_type = <Enum.dummy_cacheable_data_type: 66>

static get_name(datatype: pyrosetta.rosetta.core.pose.datacache.CacheableDataType.Enum) → str

C++: core::pose::datacache::CacheableDataType::get_name(enum core::pose::datacache::CacheableDataType::Enum) –> std::string

num_cacheable_data_types = <Enum.DEPC_MS_SASA_POSE_INFO: 65>

class pyrosetta.rosetta.core.pose.datacache.CacheableObserver

Bases: pybind11_object

Base class for Pose/Conformation observers that are stored in

a Pose’s DataCache.

Classes derived from CacheableObserver whose instances are

stored inside a Pose’s ObserverCache will be cloned and re-attached to the new Pose instance upon Pose copy construction/assignment. CacheableObservers should not need to attach themselves independently unless necessary – attach/detach should be done through the ObserverCache’s interface. For example, the ObserverCache can attach the observer upon calling ObserverCache::set().

When deriving from this class remember that Links or pointers to

subjects stored in classes are not to be copied when copy constructor/assignment is called.

assign(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver, rval: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

copy assignment

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

C++: core::pose::datacache::CacheableObserver::operator=(const class core::pose::datacache::CacheableObserver &) –> class core::pose::datacache::CacheableObserver &

attach_to(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver, pose: pyrosetta.rosetta.core.pose.Pose) → None

attach to Pose/Conformation

Derived classes do not overload this method – see attach_impl() instead.

C++: core::pose::datacache::CacheableObserver::attach_to(class core::pose::Pose &) –> void

clone(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

clone this object

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

C++: core::pose::datacache::CacheableObserver::clone() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

create(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

create a new instance of this object

C++: core::pose::datacache::CacheableObserver::create() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

detach_from(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → None

detach from Pose/Conformation

Derived classes do not overload this method – see

detach_impl() instead.

C++: core::pose::datacache::CacheableObserver::detach_from() –> void

is_attached(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → bool

is this observer attached to a Pose/Conformation?

C++: core::pose::datacache::CacheableObserver::is_attached() const –> bool

class pyrosetta.rosetta.core.pose.datacache.CacheableObserverType

Bases: pybind11_object

enum indexing the data types stored in a Pose’s internal DataCache

Members:

LENGTH_EVENT_COLLECTOR

SPECIAL_SEGMENTS_OBSERVER

ENZDES_OBSERVER

STRUCTUREDATA_OBSERVER

PYMOL_OBSERVER

UI_OBSERVER

GLYCAN_TREE_OBSERVER

num_cacheable_data_types

ENZDES_OBSERVER = <CacheableObserverType.ENZDES_OBSERVER: 3>

GLYCAN_TREE_OBSERVER = <CacheableObserverType.GLYCAN_TREE_OBSERVER: 7>

LENGTH_EVENT_COLLECTOR = <CacheableObserverType.LENGTH_EVENT_COLLECTOR: 1>

PYMOL_OBSERVER = <CacheableObserverType.PYMOL_OBSERVER: 5>

SPECIAL_SEGMENTS_OBSERVER = <CacheableObserverType.SPECIAL_SEGMENTS_OBSERVER: 2>

STRUCTUREDATA_OBSERVER = <CacheableObserverType.STRUCTUREDATA_OBSERVER: 4>

UI_OBSERVER = <CacheableObserverType.UI_OBSERVER: 6>

property name

num_cacheable_data_types = <CacheableObserverType.GLYCAN_TREE_OBSERVER: 7>

property value

class pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr

Bases: CacheableData

Holds a smart pointer (no longer a raw pointer) to a Pose so that it can be tucked inside another Pose.

assign(self: pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr, : pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr) → pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr

C++: core::pose::datacache::CacheablePoseRawPtr::operator=(const class core::pose::datacache::CacheablePoseRawPtr &) –> class core::pose::datacache::CacheablePoseRawPtr &

clone(self: pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr) → pyrosetta.rosetta.basic.datacache.CacheableData

C++: core::pose::datacache::CacheablePoseRawPtr::clone() const –> class std::shared_ptr<class basic::datacache::CacheableData>

get_self_ptr(self: pyrosetta.rosetta.basic.datacache.CacheableData) → pyrosetta.rosetta.basic.datacache.CacheableData

C++: basic::datacache::CacheableData::get_self_ptr() –> class std::shared_ptr<class basic::datacache::CacheableData>

get_self_weak_ptr(self: pyrosetta.rosetta.basic.datacache.CacheableData) → pyrosetta.rosetta.std.weak_ptr_basic_datacache_CacheableData_t

C++: basic::datacache::CacheableData::get_self_weak_ptr() –> class std::weak_ptr<class basic::datacache::CacheableData>

pose(self: pyrosetta.rosetta.core.pose.datacache.CacheablePoseRawPtr) → pyrosetta.rosetta.core.pose.Pose

C++: core::pose::datacache::CacheablePoseRawPtr::pose() –> class std::shared_ptr<class core::pose::Pose>

class pyrosetta.rosetta.core.pose.datacache.LengthEventCollector

Bases: CacheableObserver

a cacheable observer that keeps track of what length events occured

assign(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector, rval: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → pyrosetta.rosetta.core.pose.datacache.LengthEventCollector

copy assignment

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

C++: core::pose::datacache::LengthEventCollector::operator=(const class core::pose::datacache::LengthEventCollector &) –> class core::pose::datacache::LengthEventCollector &

attach_to(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver, pose: pyrosetta.rosetta.core.pose.Pose) → None

attach to Pose/Conformation

Derived classes do not overload this method – see attach_impl() instead.

C++: core::pose::datacache::CacheableObserver::attach_to(class core::pose::Pose &) –> void

clear_events(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → None

C++: core::pose::datacache::LengthEventCollector::clear_events() –> void

clone(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

clone this object

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

C++: core::pose::datacache::LengthEventCollector::clone() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

create(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

create a new instance of this object

C++: core::pose::datacache::LengthEventCollector::create() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

detach_from(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → None

detach from Pose/Conformation

Derived classes do not overload this method – see

detach_impl() instead.

C++: core::pose::datacache::CacheableObserver::detach_from() –> void

events(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → pyrosetta.rosetta.utility.vector1_core_conformation_signals_LengthEvent

C++: core::pose::datacache::LengthEventCollector::events() const –> const class utility::vector1<struct core::conformation::signals::LengthEvent, class std::allocator<struct core::conformation::signals::LengthEvent> > &

is_attached(self: pyrosetta.rosetta.core.pose.datacache.LengthEventCollector) → bool

is this observer attached to a Pose/Conformation?

C++: core::pose::datacache::LengthEventCollector::is_attached() const –> bool

class pyrosetta.rosetta.core.pose.datacache.ObserverCache

Bases: DataCache_core_pose_datacache_CacheableObserver_t

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

assign(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, rval: pyrosetta.rosetta.core.pose.datacache.ObserverCache) → pyrosetta.rosetta.core.pose.datacache.ObserverCache

copy assignment

C++: core::pose::datacache::ObserverCache::operator=(const class core::pose::datacache::ObserverCache &) –> class core::pose::datacache::ObserverCache &

attach(*args, **kwargs)

Overloaded function.

1. attach(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache) -> None

attach all stored observers to the Pose

C++: core::pose::datacache::ObserverCache::attach() –> void

2. attach(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int) -> None

attach an observer in a particular slot to the Pose

Attach the observer in this slot.

C++: core::pose::datacache::ObserverCache::attach(unsigned long) –> void

clear(*args, **kwargs)

Overloaded function.

1. clear(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache) -> None

clear all the observers

C++: core::pose::datacache::ObserverCache::clear() –> void

2. clear(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int) -> None

clear the observer in a selected slot

C++: core::pose::datacache::ObserverCache::clear(unsigned long) –> void

detach(*args, **kwargs)

Overloaded function.

1. detach(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache) -> None

detach all observers from the Pose

C++: core::pose::datacache::ObserverCache::detach() –> void

2. detach(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int) -> None

detach an observer in a particular slot to the Pose

Detach the observer in this slot.

C++: core::pose::datacache::ObserverCache::detach(unsigned long) –> void

get(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → core::pose::datacache::CacheableObserver

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::get(unsigned long) –> class core::pose::datacache::CacheableObserver &

get_const_ptr(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → core::pose::datacache::CacheableObserver

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::get_const_ptr(unsigned long) const –> class std::shared_ptr<const class core::pose::datacache::CacheableObserver>

get_ptr(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → core::pose::datacache::CacheableObserver

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::get_ptr(unsigned long) –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

get_raw_const_ptr(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → core::pose::datacache::CacheableObserver

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::get_raw_const_ptr(unsigned long) const –> const class core::pose::datacache::CacheableObserver *

get_raw_ptr(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → core::pose::datacache::CacheableObserver

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::get_raw_ptr(unsigned long) –> class core::pose::datacache::CacheableObserver *

has(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, slot: int) → bool

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::has(unsigned long) const –> bool

is_attached(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int) → bool

is the observer in the slot attached to the Pose?

true if attached, false if not attached or no observer

exists in the slot

C++: core::pose::datacache::ObserverCache::is_attached(unsigned long) const –> bool

resize(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t, n_slots: int) → None

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::resize(unsigned long) –> void

set(*args, **kwargs)

Overloaded function.

1. set(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int, observer: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) -> None

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

the Pose

slot to use.

The Observer to clone() and store.

this function exists to ensure the base class version is

overridden

C++: core::pose::datacache::ObserverCache::set(unsigned long, class std::shared_ptr<class core::pose::datacache::CacheableObserver>) –> void

2. set(self: pyrosetta.rosetta.core.pose.datacache.ObserverCache, slot: int, observer: pyrosetta.rosetta.core.pose.datacache.CacheableObserver, auto_attach: bool) -> None

store a copy of the observer in the given slot

slot to use.

The Observer to clone() and store.

Attach the observer to the Pose?

C++: core::pose::datacache::ObserverCache::set(unsigned long, class std::shared_ptr<class core::pose::datacache::CacheableObserver>, bool) –> void

size(self: pyrosetta.rosetta.basic.datacache.DataCache_core_pose_datacache_CacheableObserver_t) → int

C++: basic::datacache::DataCache<core::pose::datacache::CacheableObserver>::size() const –> unsigned long

class pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore

Bases: CacheableData

data about each residue. Once stored in a pose, data can be retrieved in the following manner:

#include <core/pose/util.hh> bool is_conserved = core::pose::is_position_conserved_residue(pose, residue)

assign(self: pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore, : pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore) → pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore

C++: core::pose::datacache::PositionConservedResiduesStore::operator=(const class core::pose::datacache::PositionConservedResiduesStore &) –> class core::pose::datacache::PositionConservedResiduesStore &

clone(self: pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore) → pyrosetta.rosetta.basic.datacache.CacheableData

Creates a copy of this instance

C++: core::pose::datacache::PositionConservedResiduesStore::clone() const –> class std::shared_ptr<class basic::datacache::CacheableData>

get_self_ptr(self: pyrosetta.rosetta.basic.datacache.CacheableData) → pyrosetta.rosetta.basic.datacache.CacheableData

C++: basic::datacache::CacheableData::get_self_ptr() –> class std::shared_ptr<class basic::datacache::CacheableData>

get_self_weak_ptr(self: pyrosetta.rosetta.basic.datacache.CacheableData) → pyrosetta.rosetta.std.weak_ptr_basic_datacache_CacheableData_t

C++: basic::datacache::CacheableData::get_self_weak_ptr() –> class std::weak_ptr<class basic::datacache::CacheableData>

is_conserved(self: pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore, residue: int) → bool

Returns true if <residue> is positionally conserved, false otherwise

C++: core::pose::datacache::PositionConservedResiduesStore::is_conserved(unsigned long) const –> bool

set_conserved(self: pyrosetta.rosetta.core.pose.datacache.PositionConservedResiduesStore, residue: int, conserved: bool) → None

Updates the positional conservation of <residue>

C++: core::pose::datacache::PositionConservedResiduesStore::set_conserved(unsigned long, bool) –> void

class pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver

Bases: CacheableObserver

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

add_segment(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver, begin: int, end: int) → None

C++: core::pose::datacache::SpecialSegmentsObserver::add_segment(unsigned long, unsigned long) –> void

assign(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver, rval: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver

C++: core::pose::datacache::SpecialSegmentsObserver::operator=(const class core::pose::datacache::SpecialSegmentsObserver &) –> class core::pose::datacache::SpecialSegmentsObserver &

attach_to(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver, pose: pyrosetta.rosetta.core.pose.Pose) → None

attach to Pose/Conformation

Derived classes do not overload this method – see attach_impl() instead.

C++: core::pose::datacache::CacheableObserver::attach_to(class core::pose::Pose &) –> void

clear(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → None

C++: core::pose::datacache::SpecialSegmentsObserver::clear() –> void

clone(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

clone this object

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

C++: core::pose::datacache::SpecialSegmentsObserver::clone() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

create(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → pyrosetta.rosetta.core.pose.datacache.CacheableObserver

create a new instance of this object

C++: core::pose::datacache::SpecialSegmentsObserver::create() –> class std::shared_ptr<class core::pose::datacache::CacheableObserver>

detach_from(self: pyrosetta.rosetta.core.pose.datacache.CacheableObserver) → None

detach from Pose/Conformation

Derived classes do not overload this method – see

detach_impl() instead.

C++: core::pose::datacache::CacheableObserver::detach_from() –> void

is_attached(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → bool

is this observer attached to a Pose/Conformation?

C++: core::pose::datacache::SpecialSegmentsObserver::is_attached() const –> bool

segments(self: pyrosetta.rosetta.core.pose.datacache.SpecialSegmentsObserver) → pyrosetta.rosetta.utility.vector1_std_pair_unsigned_long_unsigned_long_t

C++: core::pose::datacache::SpecialSegmentsObserver::segments() const –> const class utility::vector1<struct std::pair<unsigned long, unsigned long>, class std::allocator<struct std::pair<unsigned long, unsigned long> > > &

static set_farray_from_sso(array: pyrosetta.rosetta.ObjexxFCL.FArray1D_bool_t, pose: pyrosetta.rosetta.core.pose.Pose, value: bool) → None

utility function that sets all elements found in the

SpecialSegmentsObserver in the pose to value

C++: core::pose::datacache::SpecialSegmentsObserver::set_farray_from_sso(class ObjexxFCL::FArray1D<bool> &, const class core::pose::Pose &, const bool) –> void