Impact Acquire SDK .NET
OutputSignalGeneratorBlueDevice Class Referencesealed

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

Inheritance diagram for OutputSignalGeneratorBlueDevice:
[legend]

Public Member Functions

bool canCreateExposeActiveSignal (DigitalOutput output)
 Checks whether the specified output can be used to create an inverted expose active signal.
 
bool canInvertSignal (DigitalOutput output)
 Checks whether the specified output can be used to create an inverted version of a certain signal.
 
IEnumerable< TgetEnumerable< T > ()
 Returns an enumerator of a certain type that iterates through the collection.
 
IEnumerator< intGetEnumerator ()
 Returns an enumerator that iterates through the collection.
 
TDeviceDigitalOutputMode getOutputMode (DigitalOutput output)
 Returns the current mode a digital output is operated in.
 
bool isOutputModeActive (DigitalOutput output, TDeviceDigitalOutputMode mode)
 Checks whether the specified output is currently operated in a certain mode.
 
bool isSignalInverted (DigitalOutput output)
 Checks whether the specified output will currently invert a certain internal signal.
 
 OutputSignalGeneratorBlueDevice (Device device)
 Constructs a new mv.impact.acquire.OutputSignalGeneratorBlueDevice object.
 
void restoreDefault ()
 Restores the default for every component of this collection.
 
int setOutputMode (DigitalOutput output, TDeviceDigitalOutputMode mode, bool inverted)
 This function will configure the digital output to operate in a certain mode.
 
int undefineSignal (DigitalOutput output)
 Removes the signal definition from the specified output pin.
 

Properties

IEnumerable< ComponentcomponentEnumerable [get]
 Returns an enumerator that iterates through the collection.
 
IEnumerable< ComponentListcomponentListEnumerable [get]
 Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
 
int hObj [get]
 Returns a unique identifier for the component collection referenced by this object.
 

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 mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ OutputSignalGeneratorBlueDevice()

Constructs a new mv.impact.acquire.OutputSignalGeneratorBlueDevice object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

Member Function Documentation

◆ canCreateExposeActiveSignal()

bool canCreateExposeActiveSignal ( DigitalOutput output)
inline

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

Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.

◆ canInvertSignal()

bool canInvertSignal ( DigitalOutput output)
inline

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

Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.

◆ getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )
inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
}
A template class to represent 32 bit integer properties and 32 bit enumerated integer properties.
Definition EnumPropertyI.cs:61
A class to query various general information about the device, its driver and other information.
Definition Info.cs:10
A base class for properties.
Definition Property.cs:109

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns
An enumerator that iterates through the collection

◆ GetEnumerator()

IEnumerator< int > GetEnumerator ( )
inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns
An enumerator that iterates through the collection

◆ getOutputMode()

TDeviceDigitalOutputMode getOutputMode ( DigitalOutput output)
inline

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
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.

◆ isOutputModeActive()

bool isOutputModeActive ( DigitalOutput output,
TDeviceDigitalOutputMode mode )
inline

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

Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.
[in]modeThe mode the specified output shall be checked for.

◆ isSignalInverted()

bool isSignalInverted ( DigitalOutput output)
inline

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

Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.

◆ restoreDefault()

void restoreDefault ( )
inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.

◆ setOutputMode()

int setOutputMode ( DigitalOutput output,
TDeviceDigitalOutputMode mode,
bool inverted )
inline

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

Returns
Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.
[in]modeThe 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.
[in]invertedSet this parameter to true, to invert the exposure signal

◆ undefineSignal()

int undefineSignal ( DigitalOutput output)
inline

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 mv.impact.acquire.DigitalOutput. This function removes the signal definition and hands back manual control of that digital output to the user.

Returns
Parameters
[in]outputA pointer to a mv.impact.acquire.DigitalOutput object obtained from an instance of the class mv.impact.acquire.IOSubSystemCommon for this device.

Property Documentation

◆ componentEnumerable

IEnumerable<Component> componentEnumerable
getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
Console.WriteLine("{0}", c.name);
}
String name
Returns the name of the component referenced by this object.
Definition ComponentAccess.cs:167
A base class to implement access to internal driver components.
Definition Component.cs:133

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns
An enumerator that iterates through the collection

◆ componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable
getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
Console.WriteLine("{0}", cl.name);
}
A class to provide access to component lists.
Definition ComponentList.cs:14

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns
An enumerator that iterates through the collection

◆ hObj

int hObj
getinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns
A unique identifier for the component referenced by this object.