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

Search Toolkit Book for CVersionInfo

CVersionInfo –. More...

#include <corelib/version_api.hpp>

+ Inheritance diagram for CVersionInfo:

Public Types

enum  EVersionFlags { kAny = 0 , kLatest }
 
enum  EMatch { eNonCompatible , eConditionallyCompatible , eBackwardCompatible , eFullyCompatible }
 Version comparison result. More...
 

Public Member Functions

 CVersionInfo (int ver_major, int ver_minor, int patch_level=0, const string &name=kEmptyStr)
 Constructor. More...
 
 CVersionInfo (const string &version, const string &name=kEmptyStr)
 
 CVersionInfo (EVersionFlags flags=kLatest)
 
virtual ~CVersionInfo ()
 Destructor. More...
 
void FromStr (const string &version)
 Take version info from string. More...
 
void SetVersion (int ver_major, int ver_minor, int patch_level=0)
 
virtual string Print (void) const
 Print version information. More...
 
virtual string PrintXml (void) const
 Print version information as XML (see ncbi_version.xsd) More...
 
virtual string PrintJson (void) const
 Print version information as JSON. More...
 
int GetMajor (void) const
 Major version. More...
 
int GetMinor (void) const
 Minor version. More...
 
int GetPatchLevel (void) const
 Patch level. More...
 
const stringGetName (void) const
 
EMatch Match (const CVersionInfo &version_info) const
 Check if version matches another version. More...
 
bool IsAny () const
 Check if version is all zero (major, minor, patch) Convention is that all-zero version used in requests as "get me anything". More...
 
bool IsLatest () const
 Check if version is all -1 (major, minor, patch) Convention is that -1 version used in requests as "get me the latest version". More...
 
bool IsUpCompatible (const CVersionInfo &cinfo) const
 Check if this version info is more contemporary version than parameter cinfo (or the same version) More...
 

Protected Attributes

int m_Major
 Major number. More...
 
int m_Minor
 Minor number. More...
 
int m_PatchLevel
 Patch level. More...
 
string m_Name
 Name. More...
 

Detailed Description

CVersionInfo –.

Define class for storing version information.

Definition at line 116 of file version_api.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Feb 29 12:21:22 2024 by modify_doxy.py rev. 669887