Search Toolkit Book for CBlastVersion
Keeps track of the version of the BLAST engine in the NCBI C++ toolkit. More...
#include <algo/blast/api/version.hpp>
Inheritance diagram for CBlastVersion:
Collaboration diagram for CBlastVersion:
Public Member Functions | |
| CBlastVersion () | |
| virtual string | Print (void) const |
| Print version information. More... | |
| 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 string & | GetName (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... | |
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
Keeps track of the version of the BLAST engine in the NCBI C++ toolkit.
Used to perform run-time version checks
For reference, please refer to http://apr.apache.org/versioning.html
Definition at line 53 of file version.hpp.
The documentation for this class was generated from the following file:
- include/algo/blast/api/version.hpp
