Impact Acquire SDK Java
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
OutputSignalGeneratorBlueDevice Class Reference
Device Specific Interface Layout

A class to create complex digital output signals(Device specific interface layout only). More...

Public Member Functions

boolean canCreateExposeActiveSignal (DigitalOutput pOutput)
 Checks whether the specified output can be used to create an inverted expose active signal.
 
boolean canInvertSignal (DigitalOutput pOutput)
 Checks whether the specified output can be used to create an inverted version of a certain signal.
 
synchronized void delete ()
 
int getOutputMode (DigitalOutput pOutput)
 Returns the current mode a digital output is operated in.
 
boolean isOutputModeActive (DigitalOutput pOutput, int mode)
 Checks whether the specified output is currently operated in a certain mode.
 
boolean isSignalInverted (DigitalOutput pOutput)
 Checks whether the specified output will currently invert a certain internal signal.
 
 OutputSignalGeneratorBlueDevice (Device pDev)
 Constructs a new mvIMPACT.acquire.OutputSignalGeneratorBlueDevice object.
 
 OutputSignalGeneratorBlueDevice (OutputSignalGeneratorBlueDevice src)
 Constructs a new mvIMPACT.acquire.OutputSignalGeneratorBlueDevice from and existing one.
 
int setOutputMode (DigitalOutput pOutput, int mode)
 This function will configure the digital output to operate in a certain mode.
 
int setOutputMode (DigitalOutput pOutput, int mode, boolean boInverted)
 This function will configure the digital output to operate in a certain mode.
 
int undefineSignal (DigitalOutput pOutput)
 Removes the signal definition from the specified output pin.
 

Protected Member Functions

void finalize ()
 
 OutputSignalGeneratorBlueDevice (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (OutputSignalGeneratorBlueDevice obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A class to create complex digital output signals(Device specific interface layout only).

Instances of this class can be used to create more complex digital output related signals like a single pulse or sequence of pulses on a certain pin as a reaction on a signal on one of the digital inputs of a device.

The availability of the features provided by this class heavily depends on the used capture device. Therefore it's crucial to check if a desired feature is available at all. This class either provides the functions needed for these checks or its functions will return appropriate error codes.

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

◆ OutputSignalGeneratorBlueDevice() [1/3]

OutputSignalGeneratorBlueDevice ( long cPtr,
boolean cMemoryOwn )
protected

◆ OutputSignalGeneratorBlueDevice() [2/3]

OutputSignalGeneratorBlueDevice ( Device pDev)

Constructs a new mvIMPACT.acquire.OutputSignalGeneratorBlueDevice object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

◆ OutputSignalGeneratorBlueDevice() [3/3]

OutputSignalGeneratorBlueDevice ( OutputSignalGeneratorBlueDevice src)

Constructs a new mvIMPACT.acquire.OutputSignalGeneratorBlueDevice from and existing one.

Parameters
src[in] A constant reference to the mvIMPACT.acquire.OutputSignalGeneratorBlueDevice object, this object shall be created from

Member Function Documentation

◆ canCreateExposeActiveSignal()

boolean canCreateExposeActiveSignal ( DigitalOutput pOutput)

Checks whether the specified output can be used to create an inverted expose active signal.

Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.

◆ canInvertSignal()

boolean canInvertSignal ( DigitalOutput pOutput)

Checks whether the specified output can be used to create an inverted version of a certain signal.

Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.

◆ delete()

synchronized void delete ( )

◆ finalize()

void finalize ( )
protected

◆ getOutputMode()

int getOutputMode ( DigitalOutput pOutput)

Returns the current mode a digital output is operated in.

If the mode is not selectable for the current output an exception will be raised.

Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.

◆ isOutputModeActive()

boolean isOutputModeActive ( DigitalOutput pOutput,
int mode )

Checks whether the specified output is currently operated in a certain mode.

Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.
mode[in] The mode the specified output shall be checked for.

◆ isSignalInverted()

boolean isSignalInverted ( DigitalOutput pOutput)

Checks whether the specified output will currently invert a certain internal signal.

Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.

◆ setOutputMode() [1/2]

int setOutputMode ( DigitalOutput pOutput,
int mode )

This function will configure the digital output to operate in a certain mode.

After calling this function the digital output will be operated in the mode specified by mode.

Valid values for constant are defined by the enum mvIMPACT.acquire.TDeviceDigitalOutputMode.

Returns
Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.
mode[in] The mode the specified output shall be operated in. If the mode passed to the function is not available for the output or the device an exception will be raised.

◆ setOutputMode() [2/2]

int setOutputMode ( DigitalOutput pOutput,
int mode,
boolean boInverted )

This function will configure the digital output to operate in a certain mode.

After calling this function the digital output will be operated in the mode specified by mode.

Valid values for constant are defined by the enum mvIMPACT.acquire.TDeviceDigitalOutputMode.

Returns
Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.
mode[in] The mode the specified output shall be operated in. If the mode passed to the function is not available for the output or the device an exception will be raised.
boInverted[in] Set this parameter to true, to invert the exposure signal

◆ swigRelease()

static long swigRelease ( OutputSignalGeneratorBlueDevice obj)
staticprotected

◆ undefineSignal()

int undefineSignal ( DigitalOutput pOutput)

Removes the signal definition from the specified output pin.

Whenever a signal has been defined for a a certain digital output pin, this pin can no longer controlled using the corresponding functions in the class mvIMPACT.acquire.DigitalOutput. This function removes the signal definition and hands back manual control of that digital output to the user.

Returns
Parameters
pOutput[in] A pointer to a mvIMPACT.acquire.DigitalOutput object obtained from an instance of the class mvIMPACT.acquire.IOSubSystemCommon for this device.

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protected