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

Search Toolkit Book for CVersionAPI

#include <corelib/version_api.hpp>

+ Inheritance diagram for CVersionAPI:
+ Collaboration diagram for CVersionAPI:

Public Types

enum  EPrintFlags {
  fVersionInfo = 0x01 , fComponents = 0x02 , fPackageShort = 0x04 , fPackageFull = 0x08 ,
  fBuildInfo = 0x10 , fBuildSignature = 0x20 , fGI64bit = 0x40 , fTCBuildNumber = 0x0 ,
  fPrintAll = 0xFF
}
 
typedef int TPrintFlags
 Binary OR of EPrintFlags. 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

 CVersionAPI (const SBuildInfo &build_info=SBuildInfo())
 
 CVersionAPI (const CVersionInfo &version, const SBuildInfo &build_info=SBuildInfo())
 
 CVersionAPI (const CVersionAPI &version)
 
 CVersionAPI (CVersionAPI &&version)=default
 
CVersionAPIoperator= (const CVersionAPI &version)
 
CVersionAPIoperator= (CVersionAPI &&version)=default
 
void SetVersionInfo (int ver_major, int ver_minor, int patch_level=0, const string &ver_name=kEmptyStr)
 Set version information. More...
 
void SetVersionInfo (int ver_major, int ver_minor, int patch_level, const string &ver_name, const SBuildInfo &build_info)
 
void SetVersionInfo (CVersionInfo *version)
 Set version information. More...
 
void SetVersionInfo (CVersionInfo *version, const SBuildInfo &build_info)
 
const CVersionInfoGetVersionInfo () const
 Get version information. More...
 
void AddComponentVersion (const string &component_name, int ver_major, int ver_minor, int patch_level, const string &ver_name, const SBuildInfo &build_info)
 Add component version information. More...
 
void AddComponentVersion (CComponentVersionInfoAPI *component)
 Add component version information. More...
 
const SBuildInfoGetBuildInfo () const
 Get build info (date and tag, if set) More...
 
string Print (const string &appname, TPrintFlags flags=fPrintAll) const
 Print version data, plain text. More...
 
string PrintXml (const string &appname, TPrintFlags flags=fPrintAll) const
 Print version data, XML. More...
 
string PrintJson (const string &appname, TPrintFlags flags=fPrintAll) const
 Print version data, JSON. 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
 

Static Public Member Functions

static string GetPackageName (void)
 
static CVersionInfo GetPackageVersion (void)
 
static string GetPackageConfig (void)
 
- 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 Private Member Functions

static void x_Copy (CVersionAPI &to, const CVersionAPI &from)
 

Private Attributes

unique_ptr< CVersionInfom_VersionInfo
 
vector< unique_ptr< CComponentVersionInfoAPI > > m_Components
 
SBuildInfo m_BuildInfo
 

Additional Inherited Members

- 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 267 of file version_api.hpp.


The documentation for this class was generated from the following files:
Modified on Sun Apr 21 03:40:11 2024 by modify_doxy.py rev. 669887