Library

Collaboration diagram for Library:

Functions
void	Init ()
	Initializes the IDS peak ICV library.
void	Exit ()
	Deinitializes the IDS peak ICV library.
peak::common::Version	Version ()
	Returns the version of the library.

Detailed Description

Library runtime management.

Provides global control and initialization functions.

Function Documentation

Exit()

void Exit ( )

inline

Deinitializes the IDS peak ICV library.

This function should be called when no function of the library is needed anymore. It releases all allocated memory and destroys all handles along with their associated resources.

Calls to Init and Exit are reference counted, so you have to call Exit as many times as you have called Init.

After the library has been deinitialized, its functions (except for Init) will not be operable until Init is called again.

Note

Calling any other function (except Init) after calling Exit will result in an InvalidConfigurationException.

Exceptions

InvalidConfigurationException

if the library is not initialized.

Since

ids_peak_icv 1.0

Definition at line 75 of file peak_icv_library.hpp.

Init()

void Init ( )

inline

Initializes the IDS peak ICV library.

This function must be called prior to any other function call, otherwise no IDS peak ICV function is operable.

The function may be called multiple times from a single client process, but note that for each call there has to be a corresponding call to Exit when closing the library.

Note

Calling any other function before Init will result in an InvalidConfigurationException.

Since

ids_peak_icv 1.0

Definition at line 70 of file peak_icv_library.hpp.

Version()

peak::common::Version Version ( )

inline

Returns the version of the library.

This function provides version information as a structured object containing the major, minor, subminor, and patch version numbers. It can be used to programmatically verify compatibility or display the library version at runtime.

Returns

A peak::common::Version object representing the library's version.

Definition at line 39 of file peak_icv_version.hpp.