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

Inheritance diagram for IOSubSystemFrameGrabber:

[legend]

Public Member Functions
PulseStartConfiguration	getPulseStartConfiguration (int nr)
	Returns a pointer to a mv.impact.acquire.PulseStartConfiguration associated with this device.

RTCtrProgram	getRTCtrProgram (int nr)
	Returns a pointer to a mv.impact.acquire.RTCtrProgram associated with this device.

SyncOutput	HDOutput (int nr)
	Returns a pointer to a mv.impact.acquire.SyncOutput object that represents a HD output for this device.

DigitalInput	input (int nr)
	Returns a const pointer to a mv.impact.acquire.DigitalInput object.

	IOSubSystemFrameGrabber (Device device)

DigitalOutput	output (int nr)
	Returns a pointer to a mv.impact.acquire.DigitalOutput object.

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

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

SyncOutput	VDOutput (int nr)
	Returns a pointer to a mv.impact.acquire.SyncOutput object that represents a VD output for this device.

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

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

Public Attributes
readonly EnumPropertyI< TDeviceSyncOutMode >	syncOutputMode = new EnumPropertyI<TDeviceSyncOutMode>()
	An enumerated integer property defining the current mode for sync. signal creation.

Properties
int	HDOutputCount `[get]`
	Returns the number of available HD output pins for the mv.impact.acquire.Device associated with this object.

int	inputCount `[get]`
	Returns the number of mv.impact.acquire.DigitalInput s available for the mv.impact.acquire.Device associated with this object.

int	outputCount `[get]`
	Returns the number of digital outputs available for the mv.impact.acquire.Device associated with this object.

int	pulseStartConfigurationCount `[get]`
	Returns the number of mv.impact.acquire.PulseStartConfiguration objects available for the mv.impact.acquire.Device associated with this object.

int	RTCtrProgramCount `[get]`
	Returns the number of mv.impact.acquire.RTCtrProgram s available for the mv.impact.acquire.Device associated with this object.

int	VDOutputCount `[get]`
	Returns the number of available VD output pins for the mv.impact.acquire.Device associated with this object.

Detailed Description

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

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 mv.impact.acquire.IOSubSystem.

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

Note: This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ IOSubSystemFrameGrabber()

IOSubSystemFrameGrabber ( Device device )

inline

Member Function Documentation

◆ getPulseStartConfiguration()

PulseStartConfiguration getPulseStartConfiguration ( int nr )

inlineinherited

Returns a pointer to a mv.impact.acquire.PulseStartConfiguration associated with this device.

Parameters

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

◆ getRTCtrProgram()

RTCtrProgram getRTCtrProgram ( int nr )

inlineinherited

Returns a pointer to a mv.impact.acquire.RTCtrProgram associated with this device.

Parameters

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

◆ HDOutput()

SyncOutput HDOutput ( int nr )

inline

Returns a pointer to a mv.impact.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 mv.impact.acquire.IOSubSystemFrameGrabber.HDOutputCount.

Returns: A pointer to a mv.impact.acquire.SyncOutput object.

Parameters

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

◆ input()

DigitalInput input ( int nr )

inlineinherited

Returns a const pointer to a mv.impact.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 mv.impact.acquire.IOSubSystem.readInputRegister.

Parameters

[in] nr The number of the digital input.

Examples: DigitalIOs.cs.

◆ output()

DigitalOutput output ( int nr )

inlineinherited

Returns a pointer to a mv.impact.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 mv.impact.acquire.IOSubSystem.writeOutputRegister with the corresponding bit mask.

Parameters

[in] nr The number of the digital output.

Examples: DigitalIOs.cs.

◆ readInputRegister()

override uint readInputRegister ( )

inlinesealedinherited

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.

Returns: The current state of the digital inputs where bit 0 in the result represents the state of digital input 0, bit 1 the state of digital input 1 a.s.o..

◆ readOutputRegister()

override uint readOutputRegister ( )

inlinesealedinherited

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.

Returns: The current state of the digital outputs where bit 0 in the result represents the state of digital output 0, bit 1 the state of digital output 1 a.s.o..

◆ VDOutput()

SyncOutput VDOutput ( int nr )

inline

Returns a pointer to a mv.impact.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 mv.impact.acquire.IOSubSystemFrameGrabber.VDOutputCount.

Returns: A pointer to a mv.impact.acquire.SyncOutput object.

Parameters

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

◆ writeOutputRegister() [1/2]

override void writeOutputRegister ( uint value )

inlinesealedvirtualinherited

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 mv.impact.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

[in] value The value to be applied to the output register

Reimplemented from IOSubSystem.

◆ writeOutputRegister() [2/2]

override void writeOutputRegister	(	uint	value,
		uint	mask )

inlinesealedinherited

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 mv.impact.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

[in]	value	The value to be applied to the output register
[in]	mask	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.

Member Data Documentation

◆ syncOutputMode

readonly EnumPropertyI<TDeviceSyncOutMode> syncOutputMode = new EnumPropertyI<TDeviceSyncOutMode>()

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 mv.impact.acquire.TDeviceSyncOutMode.dsomNonInterlaced or mv.impact.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 mv.impact.acquire.IOSubSystemFrameGrabber.HDOutput can be used to access the desired output pin. Then its property mv.impact.acquire.SyncOutput.frequency_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 mv.impact.acquire.SyncOutput.frequency_Hz belonging to the pointer to the object returned by a call to mv.impact.acquire.IOSubSystemFrameGrabber.VDOutput.

Property Documentation

◆ HDOutputCount

int HDOutputCount

get

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

◆ inputCount

int inputCount

getinherited

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

Examples: DigitalIOs.cs.

◆ outputCount

int outputCount

getinherited

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

Examples: DigitalIOs.cs.

◆ pulseStartConfigurationCount

int pulseStartConfigurationCount

getinherited

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

Examples: DigitalIOs.cs.

◆ RTCtrProgramCount

int RTCtrProgramCount

getinherited

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

Examples: DigitalIOs.cs.

◆ VDOutputCount

int VDOutputCount

get

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

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ IOSubSystemFrameGrabber()

Member Function Documentation

◆ getPulseStartConfiguration()

◆ getRTCtrProgram()

◆ HDOutput()

◆ input()

◆ output()

◆ readInputRegister()

◆ readOutputRegister()

◆ VDOutput()

◆ writeOutputRegister() [1/2]

◆ writeOutputRegister() [2/2]

Member Data Documentation

◆ syncOutputMode

Property Documentation

◆ HDOutputCount

◆ inputCount

◆ outputCount

◆ pulseStartConfigurationCount

◆ RTCtrProgramCount

◆ VDOutputCount