VisionBox .NET Library
VIB_NET::DeviceInfo Class Reference

Detailed Description

Collection of information about a device type

This class represents information about the implementation of the iDevice interface, like RS422 or DigitalInput. VIBSystem::GetDeviceInfo() and VIBSystem::DeviceInfoList use this type to store the information.

Public Member Functions

int CompareTo (VIB_NET::DeviceInfo ^ otherDevice)
 Compares two instances of DeviceInfo. More...
 
 DeviceInfo (DeviceInfo ^ Obj)
 Creates an copy of a DeviceInfo. More...
 
 DeviceInfo (VIB_NET::eDEVICE_TYPE Type, UInt32 Number)
 Creates an instance of DeviceInfo. More...
 
Boolean Equals (VIB_NET::DeviceInfo ^ otherDevice)
 Test two instances of DeviceInfo on equality. More...
 

Properties

UInt32 NumberOfEntities [get]
 Number of entities of this device More...
 
VIB_NET::eDEVICE_TYPE Type [get]
 Returns the device type. More...
 

Constructor & Destructor Documentation

◆ DeviceInfo() [1/2]

VIB_NET::DeviceInfo::DeviceInfo ( VIB_NET::eDEVICE_TYPE  Type,
UInt32  Number 
)

Creates an instance of DeviceInfo.

Parameters
TypeType of device.
NumberNumber of entities of the device.

◆ DeviceInfo() [2/2]

VIB_NET::DeviceInfo::DeviceInfo ( DeviceInfo Obj)

Creates an copy of a DeviceInfo.

Parameters
ObjInstance to copy.


Member Function Documentation

◆ CompareTo()

int VIB_NET::DeviceInfo::CompareTo ( VIB_NET::DeviceInfo otherDevice)

Compares two instances of DeviceInfo.

Parameters
otherDeviceAnother instance of DeviceInfo
Returns
0: types of both instances are equal.
-1: type of the main instance is lower than the type of the other instance.
1: type of the main instance is higher than the type of the other instance.

◆ Equals()

Boolean VIB_NET::DeviceInfo::Equals ( VIB_NET::DeviceInfo otherDevice)

Test two instances of DeviceInfo on equality.

Parameters
otherDeviceAnother instance of DeviceInfo
Returns
true: types of both instances are equal.
false: types of both instances are different.

Property Documentation

◆ NumberOfEntities

VIB_NET::DeviceInfo::NumberOfEntities
get

Number of entities of this device

Returns
Number of entities

◆ Type

VIB_NET::DeviceInfo::Type
get

Returns the device type.

Returns
Type of device.