NCBI C++ ToolKit
Private Member Functions | List of all members
ncbi::blast::CBlastVdbVersion Class Reference

Search Toolkit Book for ncbi::blast::CBlastVdbVersion

#include "CBlastVdbVersion.hpp"
(Private to src/app/blastvdb.)

+ Inheritance diagram for ncbi::blast::CBlastVdbVersion:
+ Collaboration diagram for ncbi::blast::CBlastVdbVersion:

Private Member Functions

virtual string Print (void) const
 Print version information. More...
 

Additional Inherited Members

- Public Types inherited from CVersionInfo
enum  EVersionFlags { kAny = 0 , kLatest }
 
enum  EMatch { eNonCompatible , eConditionallyCompatible , eBackwardCompatible , eFullyCompatible }
 Version comparison result. More...
 
- Public Member Functions inherited from CBlastVersion
 CBlastVersion ()
 
- Public Member Functions inherited from CVersionInfo
 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 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 inherited from CVersionInfo
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

Definition at line 12 of file CBlastVdbVersion.hpp.

Member Function Documentation

◆ Print()

virtual string ncbi::blast::CBlastVdbVersion::Print ( void  ) const
inlineprivatevirtual

Print version information.

Returns
String representation of the version, Version information is printed in the following forms:
  • <ver_major>.<ver_minor>.<patch_level>
  • <ver_major>.<ver_minor>.<patch_level> (<name>) Return empty string if major version is undefined (< 0).

Reimplemented from CBlastVersion.

Definition at line 13 of file CBlastVdbVersion.hpp.

References CBlastVersion::Print(), and version.


The documentation for this class was generated from the following file:
Modified on Sat Apr 13 11:49:40 2024 by modify_doxy.py rev. 669887