IntaRNA::PredictionTrackerHub Class Reference

#include <PredictionTrackerHub.h>

Inheritance diagram for IntaRNA::PredictionTrackerHub:

Collaboration diagram for IntaRNA::PredictionTrackerHub:

Public Member Functions
	PredictionTrackerHub (const bool deleteTrackListOnDestruction=true)
	PredictionTrackerHub (const PredictionTrackerHub &toCopy)
virtual	~PredictionTrackerHub ()
virtual void	updateOptimumCalled (const size_t i1, const size_t j1, const size_t i2, const size_t j2, const E_type energy)
virtual void	addPredictionTracker (PredictionTracker *tracker)
virtual void	setDeleteOnDestruction (const bool deleteOnDestruction)
virtual bool	isDeleteOnDestruction () const
PredictionTrackerHub &	operator= (const PredictionTrackerHub &toCopy)
bool	empty () const
Public Member Functions inherited from IntaRNA::PredictionTracker
	PredictionTracker ()
virtual	~PredictionTracker ()

Protected Attributes
std::list< PredictionTracker * >	trackList
	list of PredictionTracker objects to forward to
bool	deleteTrackListOnDestruction

Detailed Description

Hub implementation of an PredictionTracker that forwards each reported interaction to each of the registered PredictionTracker instances.

Constructor & Destructor Documentation

PredictionTrackerHub() [1/2]

IntaRNA::PredictionTrackerHub::PredictionTrackerHub ( const bool  deleteTrackListOnDestruction = true )

inline

construction

Parameters

deleteTrackListOnDestruction

whether or not the objects the hub is forwarding to are to be deleted on destruction

PredictionTrackerHub() [2/2]

IntaRNA::PredictionTrackerHub::PredictionTrackerHub ( const PredictionTrackerHub &  toCopy )

inline

copy construction (will not delete the copied PredictionTracker list!)

Parameters

toCopy

the hub to copy

~PredictionTrackerHub()

IntaRNA::PredictionTrackerHub::~PredictionTrackerHub ( )

inlinevirtual

destruction

Member Function Documentation

addPredictionTracker()

void IntaRNA::PredictionTrackerHub::addPredictionTracker ( PredictionTracker *  tracker )

inlinevirtual

Adds a new PredictionTracker to the forwarding list.

Parameters

tracker

pointer to the tracker to forward to

empty()

bool IntaRNA::PredictionTrackerHub::empty ( ) const

inline

Whether or not a tracker is registered for forwarding.

Returns

true if any tracker is registered; false otherwise

isDeleteOnDestruction()

bool IntaRNA::PredictionTrackerHub::isDeleteOnDestruction ( ) const

inlinevirtual

Returns whether or not the PredictionTracker instances this hub forwards to are deleted when this hub is deleted.

Returns

true: forward objects are deleted; false: not

operator=()

PredictionTrackerHub & IntaRNA::PredictionTrackerHub::operator= ( const PredictionTrackerHub &  toCopy )

inline

Copies the trackList of toCopy but wont delete it later.

NOTE: this (copy) hub will NOT delete the trackList to avoid duplicated deletions. This should be done by the original hub (toCopy)

Parameters

toCopy

the tracker to make this a copy of

Returns

the altered range object (*this)

setDeleteOnDestruction()

void IntaRNA::PredictionTrackerHub::setDeleteOnDestruction ( const bool  deleteOnDestruction )

inlinevirtual

Defines whether or not the PredictionTracker instances this hub forwards to are deleted when this hub is deleted.

Parameters

deleteOnDestruction

true: forward objects are deleted; false: not

updateOptimumCalled()

void IntaRNA::PredictionTrackerHub::updateOptimumCalled ( const size_t  i1, const size_t  j1, const size_t  i2, const size_t  j2, const E_type  energy  )

inlinevirtual

Informs all registered trackers that Predictor.updateOptima() was called with the given data.

Parameters

i1	the index of the first sequence interacting with i2
j1	the index of the first sequence interacting with j2
i2	the index of the second sequence interacting with i1
j2	the index of the second sequence interacting with j1
energy	the overall energy of the interaction site

Implements IntaRNA::PredictionTracker.

Member Data Documentation

deleteTrackListOnDestruction

bool IntaRNA::PredictionTrackerHub::deleteTrackListOnDestruction

protected

whether or not the elements in trackList are to be deleted when this object is destroyed

trackList

std::list< PredictionTracker * > IntaRNA::PredictionTrackerHub::trackList

protected

list of PredictionTracker objects to forward to

---

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

• src/IntaRNA/PredictionTrackerHub.h