NCBI C++ ToolKit
Public Member Functions | Private Attributes
CEffectiveSearchSpacesMemento Class Reference

Search Toolkit Book for CEffectiveSearchSpacesMemento

Memento class to save, replace out, and restore the effective search space options of the CBlastOptions object passed to its constructor. More...

#include "blast_memento_priv.hpp"
(Private to src/algo/blast/api.)

+ Collaboration diagram for CEffectiveSearchSpacesMemento:

List of all members.

Public Member Functions

 CEffectiveSearchSpacesMemento (CBlastOptions *options)
 Parametrized constructor.
 ~CEffectiveSearchSpacesMemento ()
 Destructor.

Private Attributes

CBlastOptionsm_Options
 Snapshopt of BLAST options.
BlastEffectiveLengthsOptionsm_EffLenOrig
 Original effective length options.
BlastEffectiveLengthsOptionsm_EffLenReplace
 Effective length that will be replaced in the BLAST options object.

Detailed Description

Memento class to save, replace out, and restore the effective search space options of the CBlastOptions object passed to its constructor.

This is done because the SplitQuery_SetEffectiveSearchSpace function modifies the search spaces in the CBlastOptions object, but this shouldn't be modified, so a temporary object is created and the destroyed.

Definition at line 107 of file blast_memento_priv.hpp.


Constructor & Destructor Documentation


Member Data Documentation

Original effective length options.

Definition at line 144 of file blast_memento_priv.hpp.

Referenced by CEffectiveSearchSpacesMemento(), and ~CEffectiveSearchSpacesMemento().

Effective length that will be replaced in the BLAST options object.

Definition at line 146 of file blast_memento_priv.hpp.

Referenced by CEffectiveSearchSpacesMemento(), and ~CEffectiveSearchSpacesMemento().

Snapshopt of BLAST options.

Definition at line 142 of file blast_memento_priv.hpp.

Referenced by ~CEffectiveSearchSpacesMemento().


The documentation for this class was generated from the following file:
Modified on Sat Jul 12 17:02:57 2014 by modify_doxy.py rev. 426318