A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only) (deprecated. More...

Inheritance diagram for IOSubSystemFrameGrabber:

[legend]

Public Member Functions
synchronized void	delete ()

long	getHDOutputCount ()
	Returns the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.

long	getInputCount ()
	Returns the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.

long	getOutputCount ()
	Returns the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.

PulseStartConfiguration	getPulseStartConfiguration (long nr)
	Returns a pointer to a mvIMPACT.acquire.PulseStartConfiguration associated with this device.

long	getPulseStartConfigurationCount ()
	Returns the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.

RTCtrProgram	getRTCtrProgram (long nr)
	Returns a pointer to a mvIMPACT.acquire.RTCtrProgram associated with this device.

PropertyI	getSyncOutputMode ()
	An enumerated integer property defining the current mode for sync.

long	getVDOutputCount ()
	Returns the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.

SyncOutput	HDOutput (long nr)
	Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a HD output for this device.

DigitalInput	input (long nr)
	Returns a const pointer to a mvIMPACT.acquire.DigitalInput object.

DigitalOutput	output (long nr)
	Returns a pointer to a mvIMPACT.acquire.DigitalOutput object.

long	readInputRegister ()
	Returns the current state of the digital input register.

long	readOutputRegister ()
	Returns the current state of the digital output register.

long	RTCtrProgramCount ()
	Returns the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.

SyncOutput	VDOutput (long nr)
	Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a VD output for this device.

void	writeOutputRegister (long value)
	Alters the state of the digital output register.

void	writeOutputRegister (long value, long mask)
	Alters the state of the digital output register.

Protected Member Functions
void	finalize ()

	IOSubSystemFrameGrabber (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (IOSubSystem obj)

static long	swigRelease (IOSubSystemCommon obj)

static long	swigRelease (IOSubSystemFrameGrabber obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only) (deprecated.

Deprecated: Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

This class provides a convenient basic access to the digital inputs and outputs of a frame grabber device.

Note: The number of digital inputs and outputs available will vary significantly from device to device. Some devices might not even have digital inputs and/or digital outputs. Therefore it's crucial to check for available pins before using them. The corresponding functions to do that can be found in the base class mvIMPACT.acquire.IOSubSystem.

To create more complex digital output related signals the class mvIMPACT.acquire.OutputSignalGeneratorFrameGrabber should be used.

Note: This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ IOSubSystemFrameGrabber()

IOSubSystemFrameGrabber	(	long	cPtr,
		boolean	cMemoryOwn )

protected

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from IOSubSystemCommon.

◆ finalize()

void finalize ( )

protected

Reimplemented from IOSubSystemCommon.

◆ getHDOutputCount()

long getHDOutputCount ( )

Returns the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.

◆ getInputCount()

long getInputCount ( )

inherited

Returns the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.

◆ getOutputCount()

long getOutputCount ( )

inherited

Returns the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.

◆ getPulseStartConfiguration()

PulseStartConfiguration getPulseStartConfiguration ( long nr )

inherited

Returns a pointer to a mvIMPACT.acquire.PulseStartConfiguration associated with this device.

Parameters

nr	[in] The number of the pulse start configuration to return

◆ getPulseStartConfigurationCount()

long getPulseStartConfigurationCount ( )

inherited

Returns the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.

◆ getRTCtrProgram()

RTCtrProgram getRTCtrProgram ( long nr )

inherited

Returns a pointer to a mvIMPACT.acquire.RTCtrProgram associated with this device.

Parameters

nr	[in] The number of the real time controller program to return

◆ getSyncOutputMode()

PropertyI getSyncOutputMode ( )

An enumerated integer property defining the current mode for sync.

signal creation.

Sometimes it's desired to create a signal to sync. cameras connected to a capture device. E.g. when capturing 3 monochrome cameras in parallel these should be synchronized. Therefore some devices can create HD and VD signals that synchronize the connected cameras.

To create sync. signals this property must be set either to mvIMPACT.acquire.TDeviceSyncOutMode.dsomNonInterlaced or mvIMPACT.acquire.TDeviceSyncOutMode.dsomInterlaced.

In interlaced mode only the frequency of the VD signals can be modified, while in non-interlaced mode the width (in percent) the signal stays low can be modified as well.

Now e.g. to sync. two or more CCIR compliant cameras connected to a capture device that can create sync. signals, the HD signals must be generated with a CCIR compliant frequency. The function mvIMPACT.acquire.IOSubSystemFrameGrabber.getHDOutput() can be used to access the desired output pin. Then its property mvIMPACT.acquire.SyncOutput.getFrequency_Hz() is set to 15625 Hz (CCIR standard). The remaining values can be left untouched. The capture device will no generate HD signals with the desired frequency and VD outputs with the frequency stored by the property mvIMPACT.acquire.SyncOutput.getFrequency_Hz() belonging to the pointer to the object returned by a call to mvIMPACT.acquire.IOSubSystemFrameGrabber.getVDOutput().

◆ getVDOutputCount()

long getVDOutputCount ( )

Returns the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.

◆ HDOutput()

SyncOutput HDOutput ( long nr )

Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a HD output for this device.

nr MUST be a valid number ( larger or equal than 0 and smaller than the value returned by mvIMPACT.acquire.IOSubSystemFrameGrabber.getHDOutputCount.

Returns: A pointer to a mvIMPACT.acquire.SyncOutput object.

Parameters

nr	[in] The number of the HD output to return.

◆ input()

DigitalInput input ( long nr )

inherited

Returns a const pointer to a mvIMPACT.acquire.DigitalInput object.

Note: The possibility to access the digital inputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT.acquire.IOSubSystem.readInputRegister.

Parameters

nr	[in] The number of the digital input.

◆ output()

DigitalOutput output ( long nr )

inherited

Returns a pointer to a mvIMPACT.acquire.DigitalOutput object.

Note: The possibility to access the digital outputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT.acquire.IOSubSystem.writeOutputRegister with the corresponding bit mask.

Parameters

nr	[in] The number of the digital output.

◆ readInputRegister()

long readInputRegister ( )

inherited

Returns the current state of the digital input register.

This function can be used to read all digital inputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital inputs 0 and 1 are currently have a voltage considered as logical '1' applied to them.

◆ readOutputRegister()

long readOutputRegister ( )

inherited

Returns the current state of the digital output register.

This function can be used to read all digital outputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital output 0 and 1 are currently set to high.

◆ RTCtrProgramCount()

long RTCtrProgramCount ( )

inherited

Returns the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.

◆ swigRelease() [1/3]

static long swigRelease ( IOSubSystem obj )

staticprotectedinherited

◆ swigRelease() [2/3]

static long swigRelease ( IOSubSystemCommon obj )

staticprotectedinherited

◆ swigRelease() [3/3]

static long swigRelease ( IOSubSystemFrameGrabber obj )

staticprotected

◆ VDOutput()

SyncOutput VDOutput ( long nr )

Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a VD output for this device.

nr MUST be a valid number ( larger or equal than 0 and smaller than the value returned by mvIMPACT.acquire.IOSubSystemFrameGrabber.getVDOutputCount.

Returns: A pointer to a mvIMPACT.acquire.SyncOutput object.

Parameters

nr	[in] The number of the VD output to return.

◆ writeOutputRegister() [1/2]

void writeOutputRegister ( long value )

inherited

Alters the state of the digital output register.

This function can be used to alter the state of certain (or all) digital outputs with a single function call. By working with the parameter mask certain bits can remain unaffected.

EXAMPLE

If the previous state of a digital output register was '5', which means that outputs 0 and 2 are set to high a call to mvIMPACT.acquire.IOSubSystem.writeOutputRegister with value set to 2 and mask set to 3 would result in '6' as the new value for the output register. Pin 2 will remain unaffected, as mask states just to modify pin 0 and 1 ( 3 = 00000011 binary ).

Parameters

value [in] The value to be applied to the output register set to '1' in this parameter means that the state of this output has to adopt its style according to the value in value.

Reimplemented from IOSubSystem.

◆ writeOutputRegister() [2/2]

void writeOutputRegister	(	long	value,
		long	mask )

inherited

Alters the state of the digital output register.

This function can be used to alter the state of certain (or all) digital outputs with a single function call. By working with the parameter mask certain bits can remain unaffected.

EXAMPLE

If the previous state of a digital output register was '5', which means that outputs 0 and 2 are set to high a call to mvIMPACT.acquire.IOSubSystem.writeOutputRegister with value set to 2 and mask set to 3 would result in '6' as the new value for the output register. Pin 2 will remain unaffected, as mask states just to modify pin 0 and 1 ( 3 = 00000011 binary ).

Parameters

value	[in] The value to be applied to the output register
mask	[in] The mask to specify which pins to modify. A bit set to '1' in this parameter means that the state of this output has to adopt its style according to the value in value.

Reimplemented from IOSubSystem.

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protectedinherited

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IOSubSystemFrameGrabber()

Member Function Documentation

◆ delete()

◆ finalize()

◆ getHDOutputCount()

◆ getInputCount()

◆ getOutputCount()

◆ getPulseStartConfiguration()

◆ getPulseStartConfigurationCount()

◆ getRTCtrProgram()

◆ getSyncOutputMode()

◆ getVDOutputCount()

◆ HDOutput()

◆ input()

◆ output()

◆ readInputRegister()

◆ readOutputRegister()

◆ RTCtrProgramCount()

◆ swigRelease() [1/3]

◆ swigRelease() [2/3]

◆ swigRelease() [3/3]

◆ VDOutput()

◆ writeOutputRegister() [1/2]

◆ writeOutputRegister() [2/2]

Member Data Documentation

◆ swigCMemOwn