MagicNumberEntry Class Reference

A single Magic Number entry. More...

#include <cvb/utilities/system_info.hpp>

Public Member Functions
String	Provider () const noexcept
	The friendly (= human-readable) name of the license provider, that reported this Magic Number entry. More...
String	ToolID () const noexcept
	The tool ID of the Magic Number entry. More...
String	MagicNumber () const noexcept
	The Magic Number which is tool-specific and at the same time specific to the Common Vision Blox Serial Number for which they have been bought. More...
int	SerialNumber () const noexcept
	The serial number assigned to this Magic Number entry (0 if it has no inherent link to a serial number). More...

Friends
std::vector< MagicNumberEntry >	GetMagicNumberEntries ()
	Query the set of currently available Magic Numbers. More...

Detailed Description

A single Magic Number entry.

Member Function Documentation

MagicNumber()

String MagicNumber ( ) const

inlinenoexcept

The Magic Number which is tool-specific and at the same time specific to the Common Vision Blox Serial Number for which they have been bought.

Returns

The magic number.

Exceptions

Does	not throw any exception.

Provider()

String Provider ( ) const

inlinenoexcept

The friendly (= human-readable) name of the license provider, that reported this Magic Number entry.

Returns

The provider string.

Exceptions

Does	not throw any exception.

SerialNumber()

int SerialNumber ( ) const

inlinenoexcept

The serial number assigned to this Magic Number entry (0 if it has no inherent link to a serial number).

Returns

The serial number.

Exceptions

Does	not throw any exception.

ToolID()

String ToolID ( ) const

inlinenoexcept

The tool ID of the Magic Number entry.

Returns

The tool ID string.

Exceptions

Does	not throw any exception.

Friends And Related Function Documentation

GetMagicNumberEntries

std::vector< MagicNumberEntry > GetMagicNumberEntries ( )

friend

Query the set of currently available Magic Numbers.

Returns

A vector containing the currently available magic number entries.

Exceptions

Any	exception derived from std::exception including CvbException.

In theory, the collection of available Magic Numbers can change any time. However, it is fairly unlikely that during runtime someone unplugs a dongle or removes a Node Locked license, so Common Vision Blox does not implement a costly push/event model for notifying clients during runtime about the presence of new Magic Numbers or the loss of a Magic Number. Instead, the Magic Number information can and needs to be queried using this method.