Kanzi Connect  1.1.10
Kanzi Connect C++ API
kanzi::connect::AbstractService::ServiceDescription::Version Class Reference

Encapsulates version information. More...

#include <abstract_service.hpp>

Public Types

enum  { InvalidVersionNumber = -1 }
 

Public Member Functions

string toString () const
 Converts version information to string. More...
 
bool valid () const
 Is version number valid. More...
 
 Version (int major=InvalidVersionNumber, int minor=InvalidVersionNumber)
 c++ constructor. More...
 
 Version (const string versionstr)
 constructs object from version string More...
 

Public Attributes

int m_major
 major version number "X.something" More...
 
int m_minor
 Minor version number "something.Y". More...
 

Friends

bool operator!= (const Version &lhs, const Version &rhs)
 
bool operator< (const Version &lhs, const Version &rhs)
 
bool operator<= (const Version &lhs, const Version &rhs)
 
bool operator== (const Version &lhs, const Version &rhs)
 
bool operator> (const Version &lhs, const Version &rhs)
 
bool operator>= (const Version &lhs, const Version &rhs)
 

Detailed Description

Encapsulates version information.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
InvalidVersionNumber 

Invalid value indicator.

Constructor & Destructor Documentation

◆ Version() [1/2]

kanzi::connect::AbstractService::ServiceDescription::Version::Version ( int  major = InvalidVersionNumber,
int  minor = InvalidVersionNumber 
)

c++ constructor.

initialize object.

Parameters
majormajor number
minorminor number

◆ Version() [2/2]

kanzi::connect::AbstractService::ServiceDescription::Version::Version ( const string  versionstr)

constructs object from version string

Parameters
versionstrversion in format "1.2"

Member Function Documentation

◆ toString()

string kanzi::connect::AbstractService::ServiceDescription::Version::toString ( ) const

Converts version information to string.

Returns
version as string "1.0"

◆ valid()

bool kanzi::connect::AbstractService::ServiceDescription::Version::valid ( ) const

Is version number valid.

Returns
true if version is valid.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Version lhs,
const Version rhs 
)
friend

◆ operator<

bool operator< ( const Version lhs,
const Version rhs 
)
friend

◆ operator<=

bool operator<= ( const Version lhs,
const Version rhs 
)
friend

◆ operator==

bool operator== ( const Version lhs,
const Version rhs 
)
friend

◆ operator>

bool operator> ( const Version lhs,
const Version rhs 
)
friend

◆ operator>=

bool operator>= ( const Version lhs,
const Version rhs 
)
friend

Member Data Documentation

◆ m_major

int kanzi::connect::AbstractService::ServiceDescription::Version::m_major

major version number "X.something"

◆ m_minor

int kanzi::connect::AbstractService::ServiceDescription::Version::m_minor

Minor version number "something.Y".


The documentation for this class was generated from the following file: