NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
CTmpFile Class Reference

Search Toolkit Book for CTmpFile

CTmpFile –. More...

#include <corelib/ncbifile.hpp>

+ Inheritance diagram for CTmpFile:
+ Collaboration diagram for CTmpFile:

Public Types

enum  ERemoveMode { eRemove , eNoRemove }
 What to do with the file on object destruction. More...
 
enum  EIfExists { eIfExists_Throw , eIfExists_Reset , eIfExists_ReturnCurrent }
 What to do if stream already exists in the AsInputFile/AsOutputFile. More...
 
- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CTmpFile (ERemoveMode remove_file=eRemove)
 Default constructor. More...
 
 CTmpFile (const string &file_name, ERemoveMode remove_file=eRemove)
 Constructor. More...
 
 ~CTmpFile (void)
 Destructor. More...
 
CNcbiIstreamAsInputFile (EIfExists if_exists, IOS_BASE::openmode mode=IOS_BASE::in)
 Create I/O stream on the base of our file. More...
 
CNcbiOstreamAsOutputFile (EIfExists if_exists, IOS_BASE::openmode mode=IOS_BASE::out)
 
const stringGetFileName (void) const
 Return used file name (generated or given in the constructor). More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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

 CTmpFile (const CTmpFile &)
 
CTmpFileoperator= (const CTmpFile &)
 

Private Attributes

string m_FileName
 Name of temporary file. More...
 
ERemoveMode m_RemoveOnDestruction
 Remove file on destruction. More...
 
unique_ptr< CNcbiIstreamm_InFile
 
unique_ptr< CNcbiOstreamm_OutFile
 

Additional Inherited Members

- 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

CTmpFile –.

Define class to generate temporary file name (or use specified), which can be automatically removed on the object destruction.

This class generate temporary file name in the temporary directory specified by OS. But this behavior can be changed, just set desired temporary directory using global parameter (see CParam class description) in the registry or environment (section 'NCBI', name 'TmpDir') and it will used by default in this class.

Note
The files created this way are not really temporary. If application terminates abnormally, that such files can be left on the file system. To avoid this you can use CFile::CreateTmpFile().
See also
CFile::CreateTmpFile, CFile::GetTmpName, CParam

Definition at line 2351 of file ncbifile.hpp.


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:20:23 2024 by modify_doxy.py rev. 669887