Skip to content

Pylon::VersionInfo#

Holds a four-part version number consisting of major.minor.subminor.build. More…

#include <pylon/PylonVersionInfo.h>

Public Functions#

Name
VersionInfo(bool checkBuild =false)
VersionInfo(unsigned int major, unsigned int minor, unsigned int subminor)
Constructs a version info object using the version number parts passed.
VersionInfo(unsigned int major, unsigned int minor, unsigned int subminor, unsigned int build)
Constructs a version info object using the version number parts passed.
~VersionInfo(void )
The VersionInfo destructor.
const char * getVersionString() const
Returns the complete version number as a string.
unsigned int getMajor() const
unsigned int getMinor() const
unsigned int getSubminor() const
unsigned int getBuild() const
bool operator>(const VersionInfo & rhs) const
Compares two version info objects.
bool operator==(const VersionInfo & rhs) const
Compares two version info objects.
bool operator>=(const VersionInfo & rhs) const
Compares two version info objects.
bool operator<(const VersionInfo & rhs) const
Compares two version info objects.
bool operator!=(const VersionInfo & rhs) const
Compares two version info objects.
bool operator<=(const VersionInfo & rhs) const
compares two version info objects.
const char * getPylonVersionString()
Returns the complete pylon version number as a string.

Detailed Description#

class Pylon::VersionInfo;

Holds a four-part version number consisting of major.minor.subminor.build.

This class stores a four-part version number and provides comparison operators. If you use the constructor with one parameter, the version info object will be initialized with pylon base version numbers.

You can also call the static getVersionString() method to retrieve a string containing the complete version separated by dots.

Public Functions Documentation#

function VersionInfo#

inline explicit VersionInfo(
    bool checkBuild =false
)

Constructs a version info object using pylon base version numbers. If checkBuild is set to false, the build number will not be used in comparison operators.

function VersionInfo#

inline VersionInfo(
    unsigned int major,
    unsigned int minor,
    unsigned int subminor
)

Constructs a version info object using the version number parts passed.

function VersionInfo#

inline VersionInfo(
    unsigned int major,
    unsigned int minor,
    unsigned int subminor,
    unsigned int build
)

Constructs a version info object using the version number parts passed.

function ~VersionInfo#

inline ~VersionInfo(
    void 
)

The VersionInfo destructor.

function getVersionString#

inline const char * getVersionString() const

Returns the complete version number as a string.

function getMajor#

inline unsigned int getMajor() const

Returns the major version number. For version 2.1.3.1234 the value 2 would be returned.

function getMinor#

inline unsigned int getMinor() const

Returns the minor version number. For version 2.1.3.1234 the value 1 would be returned.

function getSubminor#

inline unsigned int getSubminor() const

Returns the subminor version number. For version 2.1.3.1234 the value 3 would be returned.

function getBuild#

inline unsigned int getBuild() const

Returns the build number. For version 2.1.3.1234 the value 1234 would be returned.

function operator>#

inline bool operator>(
    const VersionInfo & rhs
) const

Compares two version info objects.

function operator==#

inline bool operator==(
    const VersionInfo & rhs
) const

Compares two version info objects.

function operator>=#

inline bool operator>=(
    const VersionInfo & rhs
) const

Compares two version info objects.

function operator<#

inline bool operator<(
    const VersionInfo & rhs
) const

Compares two version info objects.

function operator!=#

inline bool operator!=(
    const VersionInfo & rhs
) const

Compares two version info objects.

function operator<=#

inline bool operator<=(
    const VersionInfo & rhs
) const

compares two version info objects.

function getPylonVersionString#

static inline const char * getPylonVersionString()

Returns the complete pylon version number as a string.