Rosetta
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::antibody::clusters::CDRClusterSet Class Reference

Class that can determine a CDR Cluster, hold that information, and give it out when asked. More...

#include <CDRClusterSet.hh>

Inheritance diagram for protocols::antibody::clusters::CDRClusterSet:
Inheritance graph
[legend]

Public Member Functions

 CDRClusterSet (AntibodyInfo *ab_info)
 Constructor should only be used within AntibodyInfo, as it requires and is part of AbInfo. More...
 
 ~CDRClusterSet () override
 
void identify_and_set_cdr_cluster (core::pose::Pose const &pose, CDRNameEnum cdr)
 Identify the cluster of the CDR, using numbering information held in AntibodyInfo. Replace data if already present. More...
 
void clear ()
 Clear the held cluster data. More...
 
void clear (CDRNameEnum cdr)
 Remove data of CDR using normal numbering. More...
 
bool empty () const
 
bool empty (CDRNameEnum cdr) const
 
CDRClusterCOP get_cluster_data (CDRNameEnum cdr) const
 
void set_cluster_data (CDRNameEnum cdr, CDRClusterCOP cluster)
 Manually set the CDR Cluster. More...
 
CDRClusterEnum get_cluster (CDRNameEnum cdr) const
 
BasicCDRClusterSetOP get_cacheable_cluster_data () const
 Get a new BasicCDRClusterSet with copies of CDRClusters contained in this set. More...
 
void set_cacheable_cluster_data_to_pose (core::pose::Pose &pose) const
 Set a new BasicCDRClusterSet to a pose with copies of CDRClusters contained in this set. More...
 

Private Member Functions

void calculate_cdr_cluster (CDRNameEnum cdr, core::Size start, core::Size end)
 

Private Attributes

AntibodyInfoab_info_
 
CDRClusterMatcherOP cluster_matcher_
 
utility::vector1< CDRClusterOPclusters_
 

Detailed Description

Class that can determine a CDR Cluster, hold that information, and give it out when asked.

Constructor & Destructor Documentation

◆ CDRClusterSet()

protocols::antibody::clusters::CDRClusterSet::CDRClusterSet ( AntibodyInfo ab_info)

Constructor should only be used within AntibodyInfo, as it requires and is part of AbInfo.

◆ ~CDRClusterSet()

protocols::antibody::clusters::CDRClusterSet::~CDRClusterSet ( )
overridedefault

Member Function Documentation

◆ calculate_cdr_cluster()

void protocols::antibody::clusters::CDRClusterSet::calculate_cdr_cluster ( CDRNameEnum  cdr,
core::Size  start,
core::Size  end 
)
private

◆ clear() [1/2]

void protocols::antibody::clusters::CDRClusterSet::clear ( )

Clear the held cluster data.

◆ clear() [2/2]

void protocols::antibody::clusters::CDRClusterSet::clear ( CDRNameEnum  cdr)

Remove data of CDR using normal numbering.

◆ empty() [1/2]

bool protocols::antibody::clusters::CDRClusterSet::empty ( ) const

◆ empty() [2/2]

bool protocols::antibody::clusters::CDRClusterSet::empty ( CDRNameEnum  cdr) const

◆ get_cacheable_cluster_data()

BasicCDRClusterSetOP protocols::antibody::clusters::CDRClusterSet::get_cacheable_cluster_data ( ) const

Get a new BasicCDRClusterSet with copies of CDRClusters contained in this set.

◆ get_cluster()

CDRClusterEnum protocols::antibody::clusters::CDRClusterSet::get_cluster ( CDRNameEnum  cdr) const

◆ get_cluster_data()

CDRClusterCOP protocols::antibody::clusters::CDRClusterSet::get_cluster_data ( CDRNameEnum  cdr) const

◆ identify_and_set_cdr_cluster()

void protocols::antibody::clusters::CDRClusterSet::identify_and_set_cdr_cluster ( core::pose::Pose const &  pose,
CDRNameEnum  cdr 
)

Identify the cluster of the CDR, using numbering information held in AntibodyInfo. Replace data if already present.

References core::sequence::end, protocols::antibody::North, and protocols::loops::start.

◆ set_cacheable_cluster_data_to_pose()

void protocols::antibody::clusters::CDRClusterSet::set_cacheable_cluster_data_to_pose ( core::pose::Pose pose) const

Set a new BasicCDRClusterSet to a pose with copies of CDRClusters contained in this set.

References core::pose::datacache::CacheableDataType::CDR_CLUSTER_INFO, core::pose::Pose::data(), and protocols::antibody::clusters::TR().

◆ set_cluster_data()

void protocols::antibody::clusters::CDRClusterSet::set_cluster_data ( CDRNameEnum  cdr,
CDRClusterCOP  cluster 
)

Manually set the CDR Cluster.

Member Data Documentation

◆ ab_info_

AntibodyInfo* protocols::antibody::clusters::CDRClusterSet::ab_info_
private

◆ cluster_matcher_

CDRClusterMatcherOP protocols::antibody::clusters::CDRClusterSet::cluster_matcher_
private

◆ clusters_

utility::vector1< CDRClusterOP > protocols::antibody::clusters::CDRClusterSet::clusters_
private

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