NCBI C++ ToolKit
|
Search Toolkit Book for CPubCleaner
#include <objtools/cleanup/cleanup_pub.hpp>
Public Member Functions | |
virtual | ~CPubCleaner () |
virtual bool | Clean (bool fix_initials, bool strip_serial)=0 |
virtual bool | IsEmpty ()=0 |
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 |
Protected Types | |
enum | EImprintBC { eImprintBC_AllowStatusChange = 2 , eImprintBC_ForbidStatusChange } |
Static Protected Member Functions | |
static bool | CleanImprint (CImprint &imprint, EImprintBC is_status_change_allowed) |
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... | |
Definition at line 60 of file cleanup_pub.hpp.
|
protected |
Enumerator | |
---|---|
eImprintBC_AllowStatusChange | |
eImprintBC_ForbidStatusChange |
Definition at line 69 of file cleanup_pub.hpp.
|
inlinevirtual |
Definition at line 64 of file cleanup_pub.hpp.
Implemented in CMedlineEntryCleaner, CCitLetCleaner, CCitPatCleaner, CCitProcCleaner, CCitJourCleaner, CCitBookCleaner, CCitArtCleaner, CCitSubCleaner, CCitGenCleaner, and CPubEquivCleaner.
|
staticprotected |
Definition at line 544 of file cleanup_pub.cpp.
References eImprintBC_AllowStatusChange, CImprint_Base::ePrepub_in_press, ePubStatus_aheadofprint, ePubStatus_epublish, FIX_IMPRINT_FIELD, CImprint_Base::GetPages(), CImprint_Base::GetPrepub(), CImprint_Base::GetPubstatus(), CImprint_Base::GetVolume(), NStr::IsBlank(), CImprint_Base::IsSetPages(), CImprint_Base::IsSetPrepub(), CImprint_Base::IsSetPubstatus(), CImprint_Base::IsSetVolume(), CImprint_Base::ResetPrepub(), and CImprint_Base::SetPrepub().
Referenced by CCitBookCleaner::Clean(), and CCitJourCleaner::Clean().
|
pure virtual |
Implemented in CMedlineEntryCleaner, CCitLetCleaner, CCitPatCleaner, CCitProcCleaner, CCitJourCleaner, CCitBookCleaner, CCitArtCleaner, CCitSubCleaner, CCitGenCleaner, and CPubEquivCleaner.