VinConnectionInformation Class Reference

Contains the board and port information of a device or its access token. More...

#include <cvb/driver/vin_connection_information.hpp>

Public Member Functions
int	CurrentPort () const noexcept
	Gets the camera port number where the device is located. More...
int	CurrentBoard () const noexcept
	Gets the board number where the device is located. More...
String	AccessToken () const noexcept
	Gets the device access token if available. More...

Detailed Description

Contains the board and port information of a device or its access token.

Either board and port are used (e.g. by configuring a vin-driver and opening it) or the access token is used (if opened via it).

Member Function Documentation

AccessToken()

String AccessToken ( ) const

inlinenoexcept

Gets the device access token if available.

Returns

The device access token; an empty string if board and port are in use.

Exceptions

Does	not throw any exception.

CurrentBoard()

int CurrentBoard ( ) const

inlinenoexcept

Gets the board number where the device is located.

Returns

The board number. If the device has no board select interface this will always return 0.

Exceptions

Does	not throw any exception.

If an access token is in use -1 will be returned.

CurrentPort()

int CurrentPort ( ) const

inlinenoexcept

Gets the camera port number where the device is located.

Returns

The camera port. If the device has no camera select interface this will always return 0.

Exceptions

Does	not throw any exception.

If an access token is in use -1 will be returned.