NCBI C++ ToolKit
Public Member Functions | List of all members
CComponentVersionInfo Class Reference

Search Toolkit Book for CComponentVersionInfo

#include <corelib/version.hpp>

+ Inheritance diagram for CComponentVersionInfo:
+ Collaboration diagram for CComponentVersionInfo:

Public Member Functions

 CComponentVersionInfo (const string &component_name, int ver_major, int ver_minor, int patch_level=0, const string &ver_name=kEmptyStr, const SBuildInfo &build_info=SBuildInfo(__DATE__ " " __TIME__, "") .Extra(SBuildInfo::eTeamCityProjectName, NCBI_TEAMCITY_PROJECT_NAME_PROXY) .Extra(SBuildInfo::eTeamCityBuildConf, NCBI_TEAMCITY_BUILDCONF_NAME_PROXY) .Extra(SBuildInfo::eTeamCityBuildNumber, NCBI_TEAMCITY_BUILD_NUMBER_PROXY) NCBI_GIT_BRANCH_SBUILDINFO NCBI_REVISION_SBUILDINFO .Extra(SBuildInfo::eSubversionRevision, NCBI_SUBVERSION_REVISION_PROXY) .Extra(SBuildInfo::eStableComponentsVersion, NCBI_SC_VERSION_PROXY))
 Constructor. More...
 
 CComponentVersionInfo (const string &component_name, const string &version, const string &ver_name=kEmptyStr, const SBuildInfo &build_info=SBuildInfo(__DATE__ " " __TIME__, "") .Extra(SBuildInfo::eTeamCityProjectName, NCBI_TEAMCITY_PROJECT_NAME_PROXY) .Extra(SBuildInfo::eTeamCityBuildConf, NCBI_TEAMCITY_BUILDCONF_NAME_PROXY) .Extra(SBuildInfo::eTeamCityBuildNumber, NCBI_TEAMCITY_BUILD_NUMBER_PROXY) NCBI_GIT_BRANCH_SBUILDINFO NCBI_REVISION_SBUILDINFO .Extra(SBuildInfo::eSubversionRevision, NCBI_SUBVERSION_REVISION_PROXY) .Extra(SBuildInfo::eStableComponentsVersion, NCBI_SC_VERSION_PROXY))
 Constructor. More...
 
- Public Member Functions inherited from CComponentVersionInfoAPI
 CComponentVersionInfoAPI (const string &component_name, int ver_major, int ver_minor, int patch_level, const string &ver_name, const SBuildInfo &build_info)
 Constructor. More...
 
 CComponentVersionInfoAPI (const string &component_name, const string &version, const string &ver_name, const SBuildInfo &build_info)
 Constructor. More...
 
const stringGetComponentName (void) const
 Get component name. More...
 
virtual string Print (void) const
 Print version information. More...
 
virtual string PrintXml (void) const
 Print version information ax XML. More...
 
virtual string PrintJson (void) const
 Print version information as JSON. 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)
 
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...
 

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 135 of file version.hpp.


The documentation for this class was generated from the following file:
Modified on Fri Jan 05 07:24:56 2024 by modify_doxy.py rev. 669887