NodeMap::GenApiVersion Class Reference

Version information for GenICam related objects. More...

#include <cvb/genapi/node_map.hpp>

Public Member Functions
	GenApiVersion () noexcept=default
	Creates a default version object (0.0.0) More...
	GenApiVersion (std::uint16_t major, std::uint16_t minor, std::uint16_t subMinor) noexcept
	Creates a version object from version integers. More...
String	ToString () const
	Gets the string representation of this version. More...
std::uint16_t	Major () const noexcept
	Gets the major version number. More...
void	SetMajor (std::uint16_t major) noexcept
	Sets the major version number. More...
std::uint16_t	Minor () const noexcept
	Gets the minor version number. More...
void	SetMinor (std::uint16_t minor) noexcept
	Sets the minor version number. More...
std::uint16_t	SubMinor () const noexcept
	Gets the sub-minor version number. More...
void	SetSubMinor (std::uint16_t subMinor) noexcept
	Sets the sub-minor version number. More...
bool	operator== (const GenApiVersion &version) const noexcept
	Compares to an other version. More...
bool	operator!= (const GenApiVersion &version) const noexcept
	Compares to an other version. More...
bool	operator< (const GenApiVersion &version) const noexcept
	Compares to an other version. More...
bool	operator<= (const GenApiVersion &version) const noexcept
	Compares to an other version. More...
bool	operator> (const GenApiVersion &version) const noexcept
	Compares to an other version. More...
bool	operator>= (const GenApiVersion &version) const noexcept
	Compares to an other version. More...

Detailed Description

Version information for GenICam related objects.

The versions are managed as follows:

• Major: An increase indicates a change, which is not backward compatible.
• Minor: An increase indicates a change, which adds new features. It must still support old versions of the server instance.
• SubMinor: An increase indicates a bug fix. No new features are added.

Examples

GevServer/QmlGevServer.

Constructor & Destructor Documentation

GenApiVersion() [1/2]

GenApiVersion ( )

defaultnoexcept

Creates a default version object (0.0.0)

Exceptions

Does	not throw any exception.

GenApiVersion() [2/2]

GenApiVersion ( std::uint16_t  major, std::uint16_t  minor, std::uint16_t  subMinor  )

inlinenoexcept

Creates a version object from version integers.

Parameters

[in]	major	Major version number
[in]	minor	Minor version number.
[in]	subMinor	Sub-minor version number.

Exceptions

Does	not throw any exception.

Member Function Documentation

Major()

std::uint16_t Major ( ) const

inlinenoexcept

Gets the major version number.

Returns

A positive integer number containing the version.

Exceptions

Does	not throw any exception.

Minor()

std::uint16_t Minor ( ) const

inlinenoexcept

Gets the minor version number.

Returns

A positive integer number containing the version.

Exceptions

Does	not throw any exception.

operator!=()

bool operator!= ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

operator<()

bool operator< ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if this is less than the other version, otherwise false.

Exceptions

Does	not throw any exception.

operator<=()

bool operator<= ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if this is less than or equal the other version, otherwise false.

Exceptions

Does	not throw any exception.

operator==()

bool operator== ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if equal, otherwise false.

Exceptions

Does	not throw any exception.

operator>()

bool operator> ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if this is greater than the other version, otherwise false.

Exceptions

Does	not throw any exception.

operator>=()

bool operator>= ( const GenApiVersion &  version ) const

inlinenoexcept

Compares to an other version.

Parameters

[in]

version

Other version.

Returns

True if this is greater or equal than the other version, otherwise false.

Exceptions

Does	not throw any exception.

SetMajor()

void SetMajor ( std::uint16_t  major )

inlinenoexcept

Sets the major version number.

Parameters

[in]

major

The version number

Exceptions

Does	not throw any exception.

SetMinor()

void SetMinor ( std::uint16_t  minor )

inlinenoexcept

Sets the minor version number.

Parameters

[in]

minor

The version number

Exceptions

Does	not throw any exception.

SetSubMinor()

void SetSubMinor ( std::uint16_t  subMinor )

inlinenoexcept

Sets the sub-minor version number.

Parameters

[in]

subMinor

The version number

Exceptions

Does	not throw any exception.

SubMinor()

std::uint16_t SubMinor ( ) const

inlinenoexcept

Gets the sub-minor version number.

Returns

A positive integer number containing the version.

Exceptions

Does	not throw any exception.

ToString()

String ToString ( ) const

inline

Gets the string representation of this version.

Returns

The version string.

Exceptions

Any	exception derived from std::exception including CvbException.