Grabber Control Reference 14.0
Properties

Variables

long Board
 Sets or reads the selected image acquisition device via the IBoardSelect, or, if available, the IBoardSelect2 interface. More...
 
long CamPort
 Sets or reads the current camera port via the ICameraSelect interface, or, if available, the ICameraSelect2 interface. More...
 
boolean CanBasicDigIO
 Specifies whether the IBasicDigIO interface is available or not. More...
 
boolean CanBoardSelect
 Specifies whether the IBoardSelect interface is available or not. More...
 
boolean CanBoardSelect2
 Specifies whether the IBoardSelect2 interface is available or not. More...
 
boolean CanCameraSelect
 Specifies whether the ICameraSelect interface is available or not. More...
 
boolean CanCameraSelect2
 Specifies whether the ICameraSelect2 interface is available or not. More...
 
boolean CanDeviceControl
 Specifies whether the IDeviceControl interface is available or not. More...
 
boolean CanGrab2
 Specifies whether the IGrab2 interface is available or not. More...
 
boolean CanGrabber
 Specifies whether the IGrabber interface is available or not. More...
 
boolean CanImageRect
 Specifies whether the IImageRect interface is available or not. More...
 
boolean CanLinescan
 Specifies whether the ILinescan interface is available or not. More...
 
boolean CanPingPong
 Specifies whether the IPingPong interface is available or not. More...
 
boolean CanPropertyChange
 Specifies whether the IPropertyChange interface is available or not. More...
 
boolean CanRingBuffer
 Specifies whether the IRingBuffer interface is available or not. More...
 
boolean CanSoftwareTrigger
 Specifies whether the ISoftwareTrigger interface is available or not.. More...
 
boolean CanTrigger
 Specifies whether the ITrigger interface is available or not. More...
 
__int3264 Image
 Defines the image object that is assigned to the Common Vision Grabber Control. More...
 
long NumBoards
 Returns the number of image acquisition devices available in the system. The image has to support the IBoardSelect2 interface. More...
 
long NumPorts
 Ascertain the number of camera ports. More...
 
TriggerMode TriggerMode
 Sets or reads the current trigger mode via the ITrigger interface. More...
 
long VBToWait
 Sets or reads the expected vertical blanks when changing the camera port via the ICameraSelect or the ICameraSelect2 interface. More...
 

Detailed Description

Variable Documentation

◆ Board

long Board

Sets or reads the selected image acquisition device via the IBoardSelect, or, if available, the IBoardSelect2 interface.

Attention
If the IBoardSelect2 interface is available it will be used to change the actual device even if the IBoardSelect interface is available too. Notice that the Image property or some properties of the underlying Image object (e.g. its size) might change after changing the actual device.
If the board changes an ImageUpdated event is fired to indicate the change.

Within the event you should change the Image property of all controls that are using the same image as the Grabber control. All information about the image that might be stored in an application have to be updated. in case of any error the CVCError event will be fired.
Parameters
[in,out]BoardSets the selected image acquisition device
Returns
Current image acquisition device.
Related Topics:
NumBoards, CanBoardSelect2, CanBoardSelect
Examples:
Visual Basic - VB Grabber Control Example

◆ CamPort

long CamPort

Sets or reads the current camera port via the ICameraSelect interface, or, if available, the ICameraSelect2 interface.

After chaning the port the grabber will wait VBToWait vertical blanks to ensure proper re-sychronization of the PLL (phase looked loop) if the cameras are not synchronized to each other.

Attention
If the ICameraSelect2 interface is available it will be used to change the camera port even if the ICameraSelect interface is available too.
Notice that the Image property or some properties of the underlying Image object (e.g. its size) might change after changing the camera port.
If the camera port changes an ImageUpdated event is fired to indicate the change.

Within the event you should change the Image property of all controls that are using the same image as the Grabber control. All information about the image that might be stored in an application have to be updated. in case of any error the CVCError event will be fired.
Parameters
[in,out]CamPortSets the current camera port. The value ranges from 0 to NumPorts - 1.
Returns
Current cam port.
Related Topics:
VBToWait, NumPorts, CanCameraSelect2, CanCameraSelect
Examples:
Visual Basic - VB Grabber Control Example

◆ CanBasicDigIO

boolean CanBasicDigIO
readonly

Specifies whether the IBasicDigIO interface is available or not.

IBasicDigIO function can be called from within the Common Vision Digital I/O Control.

Parameters
[out]CanBasicDigIOIndicates whether the IBasicDigIO interface is available.
Returns
TRUE if IBasicDigIO interface is available, FALSE otherwise.
Examples:
Visual Basic - VB Grabber Control Example

◆ CanBoardSelect

boolean CanBoardSelect
readonly

Specifies whether the IBoardSelect interface is available or not.

Attention
If the IBoardSelect2 interface is available the IBoardSelect interface will be ignored and the IBoardSelect2 interface is used to change the actual device.
Parameters
[out]CanBoardSelectIndicates whether the IBoardSelect interface is available.
Returns
TRUE if IBoardSelect interface is available, FALSE otherwise.
Related Topics:
CanBoardSelect2, Board
Examples:
Visual Basic - VB Grabber Control Example

◆ CanBoardSelect2

boolean CanBoardSelect2
readonly

Specifies whether the IBoardSelect2 interface is available or not.

Attention
If the IBoardSelect2 interface is available it will be used to change the actual device even if the IBoardSelect interface is available too.
Parameters
[out]CanBoardSelect2Indicates whether the IBoardSelect2 interface is available.
Returns
TRUE if IBoardSelect2 interface is available, FALSE otherwise.
Related Topics:
CanBoardSelect, Board, NumBoards
Examples:
Visual Basic - VB Grabber Control Example

◆ CanCameraSelect

boolean CanCameraSelect
readonly

Specifies whether the ICameraSelect interface is available or not.

Attention
If the ICameraSelect2 interface is available the ICameraSelect interface will be ignored and the ICameraSelect2 interface is used to change the actual camera port.
Parameters
[out]CanCameraSelectIndicates whether the ICameraSelect interface is available.
Returns
TRUE if ICameraSelect interface is available, FALSE otherwise.
Related Topics:
CanCameraSelect2, CamPort, NumPorts, VBToWait
Examples:
Visual Basic - VB Grabber Control Example

◆ CanCameraSelect2

boolean CanCameraSelect2
readonly

Specifies whether the ICameraSelect2 interface is available or not.

Attention
If the ICameraSelect2 interface is available it will be used to change the actual device even if the ICameraSelect interface is available too.
Parameters
[out]CanCameraSelect2Indicates whether the ICameraSelect2 interface is available.
Returns
TRUE if CanCameraSelect2 interface is available, FALSE otherwise.
Related Topics:
CanCameraSelect, CamPort, NumPorts, VBToWait
Examples:
Visual Basic - VB Grabber Control Example

◆ CanDeviceControl

boolean CanDeviceControl
readonly

Specifies whether the IDeviceControl interface is available or not.

Attention
Using this interface you can call special driver functions that are defined in the CVB Driver User Guide for your image acquisition device.
Parameters
[out]CanDeviceControlIndicates whether the IDeviceControl interface is available.
Returns
TRUE if IDeviceControl interface is available, FALSE otherwise.
Related Topics:
SendBinaryCommand, SendStringCommand
Examples:
There are special example programs available for the selected Image Acquisition Hardware, means Framegrabber or Cameras. Please have a look at the directory CVB%\Hardware.
Visual Basic - VB Grabber Control Example

◆ CanGrab2

boolean CanGrab2
readonly

Specifies whether the IGrab2 interface is available or not.

IGrab2 functions are called to acquire images by the Common Vision Image Control.

Parameters
[out]CanGrab2Indicates whether the IGrab2 interface is available.
Returns
TRUE if IGrab2 interface is available, FALSE otherwise.
Related Topics:
CanPingPong, CanGrabber
Examples:
Visual Basic - VB Grabber Control Example

◆ CanGrabber

boolean CanGrabber
readonly

Specifies whether the IGrabber interface is available or not.

IGrabber functions are called to acquire images by the Common Vision Image Control.

Parameters
[out]CanGrabberIndicates whether the IGrabber interface is available.
Returns
TRUE if IGrabber interface is available, FALSE otherwise.
Related Topics:
CanGrab2, CanPingPong
Examples:
Visual Basic - VB Grabber Control Example

◆ CanImageRect

boolean CanImageRect
readonly

Specifies whether the IImageRect interface is available or not.

Parameters
[out]CanImageRectIndicates whether the IImageRect interface is available.
Returns
TRUE if IImageRect interface is available, FALSE otherwise.
Related Topics:
ImageSize, ImageOffset
Examples:
Visual Basic - VB Grabber Control Example

◆ CanLinescan

boolean CanLinescan
readonly

Specifies whether the ILinescan interface is available or not.

ILinescan functions can be called from withing the Common Vision Linescan Control. 
Parameters
[out]CanLinescanIndicates whether the ILinescan interface is available.
Returns
TRUE if ILinescan interface is available, FALSE otherwise.
Examples:
Visual Basic - VB Grabber Control Example

◆ CanPingPong

boolean CanPingPong
readonly

Specifies whether the IPingPong interface is available or not.

IPingPong functions are called to acquire images by the Common Vision Image Control.

Parameters
[out]CanPingPongIndicates whether the IPingPong interface is available.
Returns
TRUE if IPingPong interface is available, FALSE otherwise.
Related Topics:
CanGrab2, CanGrabber
Examples:
Visual Basic - VB Grabber Control Example

◆ CanPropertyChange

boolean CanPropertyChange
readonly

Specifies whether the IPropertyChange interface is available or not.

IPropertyChange functions are called by the control when you pass an image into the control that supports this interface. The interface will then be used to generate the ImagePropertyChanged event.

Parameters
[out]CanPropertyChangeIndicates whether the IPropertyChange interface is available.
Returns
TRUE if IPropertyChange interface is available, FALSE otherwise.
Related Topics:
ImagePropertyChanged event

◆ CanRingBuffer

boolean CanRingBuffer
readonly

Specifies whether the IRingBuffer interface is available or not.

IRingBuffer functions can be called from withing the Common Vision RingBuffer Control.

Parameters
[out]CanRingBufferIndicates whether the IRingBuffer interface is available.
Returns
TRUE if IRingBuffer interface is available, FALSE otherwise.

◆ CanSoftwareTrigger

boolean CanSoftwareTrigger
readonly

Specifies whether the ISoftwareTrigger interface is available or not..

Parameters
[out]CanSoftwareTriggerIndicates whether the ISoftwareTrigger interface is available.
Returns
TRUE if ISoftwareTrigger interface is available, FALSE otherwise.
Related Topics:
GenerateSoftwareTrigger
Examples:
Visual Basic - VB Grabber Control Example

◆ CanTrigger

boolean CanTrigger
readonly

Specifies whether the ITrigger interface is available or not.

Attention
To use the trigger you need to ensure correct trigger settings in your image acquisition device configuration file.
Specially the trigger source has to be set to a hardware trigger. After enableing the trigger start an acquisition for instance using the Grab property of the Common Vision Image Control. A trigger signal will then force the ImageSnaped evet of the Common Vision Image Control to be fired.
Parameters
[out]CanTriggerIndicates whether the ITrigger interface is available.
Returns
TRUE if ITrigger interface is available, FALSE otherwise.
Related Topics:
TriggerMode
Examples:
Visual Basic - VB Grabber Control Example

◆ Image

__int3264 Image

Defines the image object that is assigned to the Common Vision Grabber Control.

Attention
The image object manages the image information, e.g. images from disk or from a image acquisition device driver. Other interfaces may be associated with it to control the image acquisition device.
Parameters
[in,out]ImageHandle of the image object.
Returns
Image object handle.

◆ NumBoards

long NumBoards
readonly

Returns the number of image acquisition devices available in the system. The image has to support the IBoardSelect2 interface.

In this case you can select a device within the range 0...NumBoards-1 via the Board property. If the value for NumBoards is 0 then the IBoardSelect2 interface is not supported. Please check before with the CanBoardSelect2 property.

Parameters
[out]NumBoardsIndicates whether the ISoftwareTrigger interface is available.
Returns
Number of image acquisition devices.
Related Topics:
CanBoardSelect2, Board
Examples:
Visual Basic - VB Grabber Control Example

◆ NumPorts

long NumPorts
readonly

Ascertain the number of camera ports.

Parameters
[in,out]NumPortsSelect a camera port within the range from 0 to NumPorts - 1.
Returns
Number of camera ports.
Related Topics:
VBToWait, CamPort, CanBoardSelect2, CanBoardSelect
Examples:
Visual Basic - VB Grabber Control Example

◆ TriggerMode

Sets or reads the current trigger mode via the ITrigger interface.

Parameters
[in,out]TriggerModeSets the trigger mode. For more details see TriggerModeEnum.
Returns
Current trigger mode.
Related Topics:
CanTrigger
Examples:
Visual Basic - VB Grabber Control Example

◆ VBToWait

long VBToWait

Sets or reads the expected vertical blanks when changing the camera port via the ICameraSelect or the ICameraSelect2 interface.

Parameters
[in,out]VBToWaitSets vertical blanks.
Returns
Vertical blanks.
Related Topics:
CamPort, CanBoardSelect2, CanBoardSelect
Examples:
Visual Basic - VB Grabber Control Example