TriggerControl Class Reference

A class to configure the behaviour of trigger signals. More...

Inheritance diagram for TriggerControl:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
void	restoreDefault ()
	Restores the default for every component of this collection.
int	triggerSoftware ()
	Generates of software trigger command.

Public Attributes
readonly PropertyI64	triggerActivation = new PropertyI64()
	An enumerated 64 bit integer property that defines the start condition for the selected trigger.
readonly PropertyF	triggerDelayAbs_us = new PropertyF()
	Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it.
readonly PropertyI	triggerDelayLines = new PropertyI()
	Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.
readonly PropertyI	triggerDivider = new PropertyI()
	An integer property used to divide the number of incoming trigger pulses by an integer factor.
readonly PropertyI64	triggerMode = new PropertyI64()
	Defines if the selected trigger is active.
readonly EnumPropertyI64< TDeviceTriggerOverlap >	triggerOverlap = new EnumPropertyI64<TDeviceTriggerOverlap>()
	Specifies the type trigger overlap permitted with the previous frame.
readonly PropertyI64	triggerSource = new PropertyI64()
	Defines the signal that will cause the trigger event.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
String	description [get]
	Returns a name of the trigger being configured.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

Detailed Description

A class to configure the behaviour of trigger signals.

Features in this class will open up a more flexible way to configure certain trigger events for devices then the previous features('triggerInterface', 'triggerSource' and 'triggerMode' used.

Note

Not ever device will support every property listed in this class for every trigger mode. Always call mv.impact.acquire.Component.isValid to check whether a feature is available or not before using it. Otherwise an exception will be generated.

Member Function Documentation

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>())
{
  validateProperty(c);
}

See the frameworks 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 frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

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.

triggerSoftware()

int triggerSoftware ( )

inline

Generates of software trigger command.

Returns

• mv.impact.acquire.TDMR_ERROR.DMR_NO_ERROR if successful.
• A negative error code of type mv.impact.acquire.TDMR_ERROR otherwise.

Member Data Documentation

triggerActivation

readonly PropertyI64 triggerActivation = new PropertyI64()

An enumerated 64 bit integer property that defines the start condition for the selected trigger.

Valid value will be 'RisingEdge', 'FallingEdge', 'AnyEdge', 'LevelLow' or 'LevelHigh'.

triggerDelayAbs_us

readonly PropertyF triggerDelayAbs_us = new PropertyF()

Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it.

triggerDelayLines

readonly PropertyI triggerDelayLines = new PropertyI()

Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.

triggerDivider

readonly PropertyI triggerDivider = new PropertyI()

An integer property used to divide the number of incoming trigger pulses by an integer factor.

E.g. setting this value to 2 would generate 5 internal trigger events from a 10 Hz external signal.

triggerMode

readonly PropertyI64 triggerMode = new PropertyI64()

Defines if the selected trigger is active.

triggerOverlap

readonly EnumPropertyI64<TDeviceTriggerOverlap> triggerOverlap = new EnumPropertyI64<TDeviceTriggerOverlap>()

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted (or latched) for a new frame. Valid values for this property are defined by the enumeration mv.impact.acquire.TDeviceTriggerOverlap.

triggerSource

readonly PropertyI64 triggerSource = new PropertyI64()

Defines the signal that will cause the trigger event.

Currently this property will define a translation dictionary that can e.g. be queried via a call to mv.impact.acquire.PropertyI64<T>.getTranslationDict. The resulting translation dictionary can be used to select the desired trigger source either via a string or the associated 64 bit integer value.

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);
}

See the frameworks 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);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

description

String description

get

Returns a name of the trigger being configured.

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.