Search Toolkit Book for CAutoOutputFileReset
Auxiliary class to store the name of an output file, which is reset every time its GetStream method is invoked. More...
#include <algo/blast/blastinput/blast_input_aux.hpp>
Inheritance diagram for CAutoOutputFileReset:
Collaboration diagram for CAutoOutputFileReset:
Public Member Functions | |
| CAutoOutputFileReset (const string &file_name, bool use_versions=false) | |
| Constructor. More... | |
| CNcbiOstream * | GetStream () |
| Retrieve the newly opened stream, caller doesn't own the return value. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Private Member Functions | |
| CAutoOutputFileReset (const CAutoOutputFileReset &rhs) | |
| Prohibit copy constructor. More... | |
| CAutoOutputFileReset & | operator= (const CAutoOutputFileReset &rhs) |
| Prohibit assignment operator. More... | |
Private Attributes | |
| string | m_FileName |
| The file's name. More... | |
| unique_ptr< CNcbiOstream > | m_FileStream |
| The output stream. More... | |
| int | m_Version |
| File version if larger than zero. More... | |
Additional Inherited Members | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Auxiliary class to store the name of an output file, which is reset every time its GetStream method is invoked.
This is needed to handle files which are over-written at every PSI-BLAST iteration (e.g.: PSSM and ASCII PSSM)
Definition at line 47 of file blast_input_aux.hpp.
Constructor & Destructor Documentation
◆ CAutoOutputFileReset() [1/2]
|
inline |
Constructor.
- Parameters
-
file_name name of the output file [in] use_version if true, new files will be saved with versions added to the file name
Definition at line 54 of file blast_input_aux.hpp.
◆ CAutoOutputFileReset() [2/2]
|
private |
Prohibit copy constructor.
Member Function Documentation
◆ GetStream()
| CNcbiOstream * CAutoOutputFileReset::GetStream | ( | ) |
Retrieve the newly opened stream, caller doesn't own the return value.
Definition at line 50 of file blast_input_aux.cpp.
References _TRACE, CFile::Exists(), NStr::IntToString(), m_FileName, m_FileStream, m_Version, and CDirEntry::Remove().
Referenced by CPsiBlastArgs::GetAsciiMatrixOutputStream(), and CPsiBlastArgs::GetCheckPointOutputStream().
◆ operator=()
|
private |
Prohibit assignment operator.
Member Data Documentation
◆ m_FileName
|
private |
◆ m_FileStream
|
private |
◆ m_Version
|
private |
File version if larger than zero.
Definition at line 67 of file blast_input_aux.hpp.
Referenced by GetStream().
The documentation for this class was generated from the following files:
- include/algo/blast/blastinput/blast_input_aux.hpp
- src/algo/blast/blastinput/blast_input_aux.cpp
