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

Search Toolkit Book for CVecScreenVersion

#include <algo/blast/format/vecscreen_run.hpp>

+ Inheritance diagram for CVecScreenVersion:
+ Collaboration diagram for CVecScreenVersion:

Public Member Functions

 CVecScreenVersion ()
 
- 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 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...
 

Static Private Attributes

static const int kVecScreenMajorVersion = 2
 
static const int kVecScreenMinorVersion = 0
 
static const int kVecScreenPatchVersion = 0
 

Additional Inherited Members

- Public Types inherited from CVersionInfo
enum  EVersionFlags { kAny = 0 , kLatest }
 
enum  EMatch { eNonCompatible , eConditionallyCompatible , eBackwardCompatible , eFullyCompatible }
 Version comparison result. 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 53 of file vecscreen_run.hpp.

Constructor & Destructor Documentation

◆ CVecScreenVersion()

CVecScreenVersion::CVecScreenVersion ( )
inline

Definition at line 58 of file vecscreen_run.hpp.

Member Data Documentation

◆ kVecScreenMajorVersion

const int CVecScreenVersion::kVecScreenMajorVersion = 2
staticprivate

Definition at line 54 of file vecscreen_run.hpp.

◆ kVecScreenMinorVersion

const int CVecScreenVersion::kVecScreenMinorVersion = 0
staticprivate

Definition at line 55 of file vecscreen_run.hpp.

◆ kVecScreenPatchVersion

const int CVecScreenVersion::kVecScreenPatchVersion = 0
staticprivate

Definition at line 56 of file vecscreen_run.hpp.


The documentation for this class was generated from the following file:
Modified on Fri Sep 20 14:57:08 2024 by modify_doxy.py rev. 669887