NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
CInstInfoMap::SVoucherInfo Struct Reference

Search Toolkit Book for CInstInfoMap::SVoucherInfo

#include "inst_info_map.hpp"
(Private to src/objtools/format.)

+ Inheritance diagram for CInstInfoMap::SVoucherInfo:
+ Collaboration diagram for CInstInfoMap::SVoucherInfo:

Public Member Functions

 SVoucherInfo (const string *links, bool prependInstitute, bool prependCollection, int pad_to, const string *pad_with, const string *trim, const string *prefix, const string *suffix, const char *inst_full_name)
 
- 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
 

Public Attributes

const stringm_Links
 
bool m_PrependInstitute
 
bool m_PrependCollection
 
int m_PadTo
 
const stringm_PadWith
 
const stringm_Trim
 
const stringm_Prefix
 
const stringm_Suffix
 
const char * m_InstFullName
 

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< Uint8TCounter
 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

Definition at line 45 of file inst_info_map.hpp.

Constructor & Destructor Documentation

◆ SVoucherInfo()

CInstInfoMap::SVoucherInfo::SVoucherInfo ( const string links,
bool  prependInstitute,
bool  prependCollection,
int  pad_to,
const string pad_with,
const string trim,
const string prefix,
const string suffix,
const char *  inst_full_name 
)
inline

Definition at line 46 of file inst_info_map.hpp.

Member Data Documentation

◆ m_InstFullName

const char* CInstInfoMap::SVoucherInfo::m_InstFullName

Definition at line 74 of file inst_info_map.hpp.

◆ m_Links

const string* CInstInfoMap::SVoucherInfo::m_Links

Definition at line 66 of file inst_info_map.hpp.

◆ m_PadTo

int CInstInfoMap::SVoucherInfo::m_PadTo

Definition at line 69 of file inst_info_map.hpp.

◆ m_PadWith

const string* CInstInfoMap::SVoucherInfo::m_PadWith

Definition at line 70 of file inst_info_map.hpp.

◆ m_Prefix

const string* CInstInfoMap::SVoucherInfo::m_Prefix

Definition at line 72 of file inst_info_map.hpp.

◆ m_PrependCollection

bool CInstInfoMap::SVoucherInfo::m_PrependCollection

Definition at line 68 of file inst_info_map.hpp.

◆ m_PrependInstitute

bool CInstInfoMap::SVoucherInfo::m_PrependInstitute

Definition at line 67 of file inst_info_map.hpp.

◆ m_Suffix

const string* CInstInfoMap::SVoucherInfo::m_Suffix

Definition at line 73 of file inst_info_map.hpp.

◆ m_Trim

const string* CInstInfoMap::SVoucherInfo::m_Trim

Definition at line 71 of file inst_info_map.hpp.


The documentation for this struct was generated from the following file:
Modified on Thu Nov 30 04:55:37 2023 by modify_doxy.py rev. 669887