VisionBox .NET Library
VIB_NET::VIBSystem Class Reference

Detailed Description

Factory for devices

See class VIB::VIBSystem in the VisionBox Interface Library for a detailed description.

Examples

Classes

struct  Version4Parts
 Version information More...
 

Public Member Functions

void CloseDevice (VIB_NET::iDevice ^ pDevice)
 Closes device More...
 
VIB_NET::DeviceInfoGetDeviceInfo (VIB_NET::eDEVICE_TYPE Type)
 Returns the information for the specified device type More...
 
VIB_NET::iDeviceOpenDevice (VIB_NET::eDEVICE_TYPE Type, Int32 Index)
 Opens a device and creates a device object More...
 
 VIBSystem (VIB_NET::eSYSTEM_TYPE Type, UInt32 Index)
 Creates a factory instance More...
 
 VIBSystem (void)
 Creates a default factory instance. More...
 
 ~VIBSystem (void)
 Destructor More...
 

Static Public Member Functions

static VIB_NET::SystemInfoGetSystemInfo (VIB_NET::eSYSTEM_TYPE Type)
 Returns information about installed system types More...
 

Properties

Version4PartsAPI_Version [get, set]
 Contains the version of the underlying VIB_Interface library More...
 
ArrayList^ DeviceInfoList [get]
 Returns a list of available devices More...
 
Int32 NumberOfDeviceTypes [get]
 Contains the number of different device types More...
 
static String^ PlatformString [get]
 Returns a string with a list of all available systems and their entities. More...
 
static ArrayList^ SystemInfoList [get]
 Returns information about the installed systems More...
 
String^ SystemString [get]
 Returns a string with a list of all available devices and their entities. More...
 
String^ VersionString [get]
 Contains a string with version data from all components. (DLL, driver, FPGA, ...) More...
 
Version4PartsVIB_NET_Version [get, set]
 Contains the version of this library More...
 

Constructor & Destructor Documentation

◆ VIBSystem() [1/2]

VIB_NET::VIBSystem::VIBSystem ( void  )

Creates a default factory instance.

This function call is identical with VIBSystem(VIB_NET::eSYSTEM_TYPE::BASEBOARD, 0); please refer there for more details.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ VIBSystem() [2/2]

VIB_NET::VIBSystem::VIBSystem ( VIB_NET::eSYSTEM_TYPE  Type,
UInt32  Index 
)

Creates a factory instance

A call of this function checks all used components for the right version.

Parameters
TypeDesired system type
IndexIndex/Number/Address of the desired system, 0 ... (VIB_NET::SystemInfo::NumberOfEntities - 1)

◆ ~VIBSystem()

VIB_NET::VIBSystem::~VIBSystem ( void  )

Destructor

The function deletes only the factory. The call will not affect already opened devices.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

Member Function Documentation

◆ CloseDevice()

void VIB_NET::VIBSystem::CloseDevice ( VIB_NET::iDevice pDevice)

Closes device

Closes the connections to the device.

Parameters
pDevicePreviously opened device class object
Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ GetDeviceInfo()

VIB_NET::DeviceInfo VIB_NET::VIBSystem::GetDeviceInfo ( VIB_NET::eDEVICE_TYPE  Type)

Returns the information for the specified device type

Parameters
TypeType of device
Returns
Device information including the type and number of entities
Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ GetSystemInfo()

VIB_NET::SystemInfo VIB_NET::VIBSystem::GetSystemInfo ( VIB_NET::eSYSTEM_TYPE  Type)
static

Returns information about installed system types

The function returns a SystemInfo object for the specified system type that are provided by the hardware.

Parameters
TypeType of the system
Returns
System information containing the number of installed entities of the given type

◆ OpenDevice()

VIB_NET::iDevice VIB_NET::VIBSystem::OpenDevice ( VIB_NET::eDEVICE_TYPE  Type,
Int32  Index 
)

Opens a device and creates a device object

After this call there is no relationship between the factory and the device instance. Closing the factory will not close the device, it must be closed manually.

Each device can only be opened once at the same time. This is ensured for all processes running on the system. A device must be closed before it can be reopened again.

Parameters
TypeType of the device
IndexIndex of device, use GetDeviceInfo() and DeviceInfo::NumberOfEntities to obtain the number of available devices
Returns
Pointer to the new device object
Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

Property Documentation

◆ API_Version

VIB_NET::VIBSystem::API_Version
getset

Contains the version of the underlying VIB_Interface library

See Version4Parts.

Returns
API_Version
Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ DeviceInfoList

VIB_NET::VIBSystem::DeviceInfoList
get

Returns a list of available devices

The function returns a list of VIB_NET::DeviceInfo containing all devices for the associated system (hardware entity).

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ NumberOfDeviceTypes

VIB_NET::VIBSystem::NumberOfDeviceTypes
get

Contains the number of different device types

For example, if the VisionBox has two Strobe units and one RS-422 interface, the value is 2.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ PlatformString

VIB_NET::VIBSystem::PlatformString
staticget

Returns a string with a list of all available systems and their entities.

◆ SystemInfoList

VIB_NET::VIBSystem::SystemInfoList
staticget

Returns information about the installed systems

The function returns a list of VIB_NET::SystemInfo containing all installed systems or hardware entities. Each item holds information about a different system type.

Example:
//acquire information of all supported device types
System.Collections.ArrayList SysList = VIBSystem.SystemInfoList;
//search for the CL-Card
foreach(VIB_NET.SystemInfo sysInfo in SysList)
{
if (sysInfo.Type == VIB_NET.eSYSTEM_TYPE.CL)
System.Console.WriteLine("Number of CL-Cards:" + sysInfo.NumberOfEntities );
}

◆ SystemString

VIB_NET::VIBSystem::SystemString
get

Returns a string with a list of all available devices and their entities.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ VersionString

VIB_NET::VIBSystem::VersionString
get

Contains a string with version data from all components. (DLL, driver, FPGA, ...)

Do not parse or interpret this string to do any assumption. Use the string only to give the user a human readable overview about the versions. The layout and 'keywords' can be different for each hardware type.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb

◆ VIB_NET_Version

VIB_NET::VIBSystem::VIB_NET_Version
getset

Contains the version of this library

See Version4Parts.

Example:
C#: VIBSystem_Example.cs
Visual Basic: VIBSystem_Example.vb
VIB_NET
All relevant classes and functions are residing in this namespace.
Definition: CameraLinkIn.cpp:6
VIB_NET::SystemInfo
Collects information about a specific system type
Definition: VIB_NET.h:498
VIB_NET::VIBSystem::VIBSystem
VIBSystem(void)
Creates a default factory instance.
Definition: VIBSystem.cpp:76