Rosetta 3.4
Public Types | Public Member Functions
core::scoring::solid_surface::SurfaceEnergies Class Reference

#include <SurfaceEnergies.hh>

Inheritance diagram for core::scoring::solid_surface::SurfaceEnergies:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::solid_surface::SurfaceEnergies:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Energies parent

Public Member Functions

 SurfaceEnergies ()
 ctor -- ensure correct initial state
 SurfaceEnergies (SurfaceEnergies const &src)
 copy ctor -- deep copy
virtual Energies const & operator= (Energies const &rhs)
 assignment operator -- deep copy
virtual bool same_type_as_me (Energies const &other, bool recurse=true) const
virtual ~SurfaceEnergies ()
 dtor
virtual EnergiesOP clone () const
void set_total_residue (Size total_residue)
 The SurfaceEnergies object needs to know how many residues are in its pose; it also has to be told which residues are considered part of the surface and which residues are not part of the surface.
void reset_surface_residue_information ()
 Wipe away all the information in the SurfacEnergies object describing which residues are considered part of the surface and which residues are not part of the surface. (Afterwards, all residues are going to be considered part of the surface).
void set_residue_range_not_surface (Size seqpos_begin, Size seqpos_end)
 Tell the SurfacEnergies that the following residues are considered not part of the surface.
bool residue_is_surface (Size seqpos) const
 Does the SurfaceEnergies object consider a particular residue to be part of the surface?

Detailed Description

A derived class from class Energies for efficiently representing the interactions between a protein and a fixed surface


Member Typedef Documentation


Constructor & Destructor Documentation

core::scoring::solid_surface::SurfaceEnergies::SurfaceEnergies ( )

ctor -- ensure correct initial state

Referenced by clone().

core::scoring::solid_surface::SurfaceEnergies::SurfaceEnergies ( SurfaceEnergies const &  src)

copy ctor -- deep copy

core::scoring::solid_surface::SurfaceEnergies::~SurfaceEnergies ( ) [virtual]

dtor


Member Function Documentation

EnergiesOP core::scoring::solid_surface::SurfaceEnergies::clone ( ) const [virtual]

make a copy of this Energies( allocate actual memory for it )

Reimplemented from core::scoring::Energies.

References SurfaceEnergies().

Energies const & core::scoring::solid_surface::SurfaceEnergies::operator= ( Energies const &  rhs) [virtual]

assignment operator -- deep copy

Reimplemented from core::scoring::Energies.

References core::scoring::Energies::operator=().

void core::scoring::solid_surface::SurfaceEnergies::reset_surface_residue_information ( )

Wipe away all the information in the SurfacEnergies object describing which residues are considered part of the surface and which residues are not part of the surface. (Afterwards, all residues are going to be considered part of the surface).

Referenced by set_total_residue().

bool core::scoring::solid_surface::SurfaceEnergies::residue_is_surface ( Size  seqpos) const

Does the SurfaceEnergies object consider a particular residue to be part of the surface?

bool core::scoring::solid_surface::SurfaceEnergies::same_type_as_me ( Energies const &  other,
bool  recurse = true 
) const [virtual]

determine whether my type is the same as another Conformation's

If recurse is true, then this is the first call to same_type_as_me;

Reimplemented from core::scoring::Energies.

References core::scoring::Energies::same_type_as_me().

void core::scoring::solid_surface::SurfaceEnergies::set_residue_range_not_surface ( Size  seqpos_begin,
Size  seqpos_end 
)

Tell the SurfacEnergies that the following residues are considered not part of the surface.

void core::scoring::solid_surface::SurfaceEnergies::set_total_residue ( Size  total_residue)

The SurfaceEnergies object needs to know how many residues are in its pose; it also has to be told which residues are considered part of the surface and which residues are not part of the surface.

References reset_surface_residue_information().

Referenced by protocols::surface_docking::SurfaceDockingProtocol::apply().


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