CVB.Net 14.0
VinDevice Class Reference

A Device representing a video interface driver (vin). More...

Inherits Device.

Public Member Functions

bool TryGetVinConnectionInformation (out Driver.VinConnectionInformation info)
 Tries to get the board an port information of this device. More...
 
- Public Member Functions inherited from Device
void Dispose ()
 IDisposable implementation. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Additionally disposes the associated VinImage if present. More...
 
- Protected Member Functions inherited from Device
 Device (IntPtr handle, string resourceLocator)
 Creates the device from the given CVB object handle . More...
 
virtual void Dispose (bool disposing)
 IDispose helper function. More...
 

Properties

override Stream Stream [get]
 Stream of this device.
 
override int StreamCount [get]
 Number of streams of this device.
 
Driver.VinConnectionInformation VinConnectionInformation [get]
 Gets the board and port information of this device. More...
 
VinImage VinImage [get]
 Gets the VinImage of this device if available. More...
 
override DeviceImage DeviceImage [get]
 Alias for the VinImage property.
 
- Properties inherited from Device
bool IsDisposed [get]
 Tests if the native handle has already been disposed. More...
 
IntPtr Handle [get]
 Gets the native CVB object handle. More...
 
string ResourceLocator [get]
 Gets the access token or path of the file name including its extension. More...
 
virtual Guid DriverGuid [get]
 Get the globally unique identifier of a CVB driver. More...
 
virtual TriggerState TriggerMode [get, set]
 Gets or sets the trigger mode of the device if possible. More...
 
abstract int StreamCount [get]
 Number of streams this device has.
 
abstract Driver.Stream Stream [get]
 Convenience property to access the first stream if present. More...
 
abstract DeviceImage DeviceImage [get]
 Gets, if available, the device image pointing to the latest synchronized image. More...
 
virtual IDeviceControl DeviceControl [get]
 Gets the IDeviceControl interface if present. More...
 
virtual IDigitalIO DigitalIO [get]
 Gets the IDigitalIO interface object if present. More...
 
virtual ISoftwareTrigger SoftwareTrigger [get]
 Gets the ISoftwareTrigger interface object if present. More...
 
DeviceNodeMapDictionary NodeMaps [get]
 Gets the dictionary holding all available NodeMaps. More...
 
virtual IRegPort RegPort [get]
 Gets the register port interface of this device if present. More...
 
virtual IImageRect ImageRect [get]
 Gets the IImageRect interface object if present. More...
 
NotifyDictionary Notify [get]
 Gets the INotify INotifyObservables if present. More...
 
virtual ConnectionState ConnectionState [get, protected set]
 Gets the current Cvb.ConnectionState of this Device object.
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 

Additional Inherited Members

- Protected Attributes inherited from Device
readonly object LockAnchor = new object()
 Lock anchor for device specific thread synchronization.
 
- Events inherited from Device
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
 
EventHandler< PropertyValueChangedEventArgs< IntPtr > > HandleChange
 Fired if the native Handle changes due to an operation. More...
 
EventHandler< ConnectionStateChangeEventArgsConnectionStateChanged
 Event that is fired when the ConnectionState changes.
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

A Device representing a video interface driver (vin).

Member Function Documentation

◆ Dispose()

override void Dispose ( bool  disposing)
protectedvirtual

Additionally disposes the associated VinImage if present.

Parameters
disposing

Reimplemented from Device.

◆ TryGetVinConnectionInformation()

bool TryGetVinConnectionInformation ( out Driver.VinConnectionInformation  info)

Tries to get the board an port information of this device.

Parameters
infoThe Driver.VinConnectionInformation containing this device's board and camera port index.
Returns
true if successful; false if not.
Exceptions
ObjectDisposedExceptionIf this device has already been disposed.

Property Documentation

◆ VinConnectionInformation

Gets the board and port information of this device.

Driver.VinConnectionInformation containing this device's board and camera port index.

Exceptions
NullReferenceExceptionIf this is not a Vin driver supporting a board- or camera select interface.
ObjectDisposedExceptionIf this device has already been disposed.

◆ VinImage

Gets the VinImage of this device if available.

The image's content points to the latest waited on image of stream 0.