BALL::AromaticRingStacking Class Reference

#include <BALL/SCORING/COMPONENTS/aromaticRingStacking.h>

Inheritance diagram for BALL::AromaticRingStacking:

Classes
struct	Default
struct	Option

Public Member Functions
	AromaticRingStacking ()
	AromaticRingStacking (ScoringFunction &sf)
	AromaticRingStacking (const AromaticRingStacking &ars)
	~AromaticRingStacking ()
void	clear ()
virtual bool	setup (Options &options)
void	setupLigand ()
void	update (const vector< std::pair< Atom *, Atom * > > &)
virtual double	updateScore ()
Public Member Functions inherited from BALL::ScoringComponent
	ScoringComponent ()
	ScoringComponent (const ScoringComponent &sc)
	ScoringComponent (ScoringFunction &sf)
void	selectBaseFunction (String function)
virtual	~ScoringComponent ()
virtual bool	setup ()
ScoringFunction *	getScoringFunction () const
void	setScoringFunction (ScoringFunction &sf)
String	getName () const
void	setName (const String &name)
const String &	getTypeName ()
double	getRawScore () const
double	getScaledScore () const
virtual void	setLigandIntraMolecular (bool b)
bool	isLigandIntraMolecular ()
bool	isGridable ()
bool	isAtomPairwise ()
void	setCoefficient (const double &coeff)
const double &	getCoefficient ()
void	setNormalizationParameters (double stddev, double mean)
void	getNormalizationParameters (double &stddev, double &mean)
bool	isEnabled ()
void	enable ()
void	disable ()

Additional Inherited Members
Protected Member Functions inherited from BALL::ScoringComponent
double	scaleScore (double score) const
Protected Attributes inherited from BALL::ScoringComponent
bool	ligand_intra_molecular_
bool	gridable_
bool	atom_pairwise_
ScoringFunction *	scoring_function_
ScoringBaseFunction *	base_function_
double	score_
double	coefficient_
double	stddev_
double	mean_
bool	enabled_
String	type_name_

Detailed Description

Definition at line 19 of file aromaticRingStacking.h.

Constructor & Destructor Documentation

BALL::AromaticRingStacking::AromaticRingStacking

(

)

BALL::AromaticRingStacking::AromaticRingStacking

(

ScoringFunction &

sf

)

BALL::AromaticRingStacking::AromaticRingStacking

(

const AromaticRingStacking &

ars

)

BALL::AromaticRingStacking::~AromaticRingStacking

(

)

Member Function Documentation

void BALL::AromaticRingStacking::clear ( )

virtual

Reimplemented from BALL::ScoringComponent.

virtual bool BALL::AromaticRingStacking::setup ( Options &  options )

virtual

void BALL::AromaticRingStacking::setupLigand ( )

virtual

This function needs to be called once for every new ligand

Reimplemented from BALL::ScoringComponent.

void BALL::AromaticRingStacking::update ( const vector< std::pair< Atom *, Atom * > > &  pair_vector )

virtual

Update this ScoringComponent using the given atom-pairs.
This function should be overloaded by all ScoringComponents

Reimplemented from BALL::ScoringComponent.

virtual double BALL::AromaticRingStacking::updateScore ( )

virtual

Calculate the score for this component (for all interactions that have been set by the last call of update()) and return the score.
The coefficient assigned by the user to this component should be taken into account for the calculation, so that the weighted score is returned.

Reimplemented from BALL::ScoringComponent.