PulseStartConfiguration Class Reference

A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only). More...

Inheritance diagram for PulseStartConfiguration:

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.

Public Attributes
readonly EnumPropertyI< TDigitalSignal >	digitalSignal = new EnumPropertyI<TDigitalSignal>()
	An enumerated property to define one or more signals that will trigger the creation of the associated output signals.
readonly PropertyI	divider = new PropertyI()
	An integer property defining a factor by which the external input signal shall divided.
readonly PropertyF	frequency_Hz = new PropertyF()
	A float property defining the frequency in Hz. for the creation of the output signals associated with configuration.
readonly EnumPropertyI< TPulseStartTrigger >	pulseStartTrigger = new EnumPropertyI<TPulseStartTrigger>()
	An enumerated integer property that will define how/when a digital signal is generated by the device.
readonly EnumPropertyI< TTriggerMoment >	triggerMoment = new EnumPropertyI<TTriggerMoment>()
	An enumerated integer property defining the exact moment when this pulse start configuration shall be triggered.

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.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.
int	number [get]
	Returns the internal number associated with this pulse start configuration.

Detailed Description

A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only).

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.

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.

Member Data Documentation

digitalSignal

readonly EnumPropertyI<TDigitalSignal> digitalSignal = new EnumPropertyI<TDigitalSignal>()

An enumerated property to define one or more signals that will trigger the creation of the associated output signals.

This property will be visible and thus active when mv.impact.acquire.PulseStartConfiguration.digitalSignal is switched to mv.impact.acquire.TPulseStartTrigger.pstDigitalSignal.

Depending on the device one or more signals can be defined as 'active for output signal creation'. When more than one signal can be defined, calling mv.impact.acquire.EnumPropertyI<T>.allowsValueCombinations will return true.

Valid values for this property are defined by the enumeration mv.impact.acquire.TDigitalSignal.

mvHYPERION specific: Currently when more than one signal can be defined here, these signals will have an 'or relationship', which means that when any of these signals is detected, it will trigger the creation of the associated output signals.

The following signals are defined:

enum Value	Associated signal
mv.impact.acquire.TDigitalSignal.dsSignal1	Line Valid(J1)
mv.impact.acquire.TDigitalSignal.dsSignal2	Line Valid(J2)
mv.impact.acquire.TDigitalSignal.dsSignal3	Frame Valid(J1)
mv.impact.acquire.TDigitalSignal.dsSignal4	Frame Valid(J2)
mv.impact.acquire.TDigitalSignal.dsSignal5	Trigger-In(J3.4/J3.5)
mv.impact.acquire.TDigitalSignal.dsSignal6	Sync-In(J3.6/J3.7)
mv.impact.acquire.TDigitalSignal.dsSignal7	Trigger-In(J4.4/J4.5)
mv.impact.acquire.TDigitalSignal.dsSignal8	Sync-In(J4.6/J4.7)
mv.impact.acquire.TDigitalSignal.dsSignal9	DigIn0(J6.9)
mv.impact.acquire.TDigitalSignal.dsSignal10	DigIn1(J6.10)
mv.impact.acquire.TDigitalSignal.dsSignal11	DigIn2(J6.11)
mv.impact.acquire.TDigitalSignal.dsSignal12	DigIn3(J6.12)

divider

readonly PropertyI divider = new PropertyI()

An integer property defining a factor by which the external input signal shall divided.

Every divider-value pulse will be used then. All others will be skipped.

frequency_Hz

readonly PropertyF frequency_Hz = new PropertyF()

A float property defining the frequency in Hz. for the creation of the output signals associated with configuration.

This property will be visible and thus active when mv.impact.acquire.PulseStartConfiguration.digitalSignal is switched to mv.impact.acquire.TPulseStartTrigger.pstPeriodically.

pulseStartTrigger

readonly EnumPropertyI<TPulseStartTrigger> pulseStartTrigger = new EnumPropertyI<TPulseStartTrigger>()

An enumerated integer property that will define how/when a digital signal is generated by the device.

When certain digital output signals

Valid values for this property are defined by the enumeration mv.impact.acquire.TPulseStartTrigger.

Note

Not every device will offer the same options. Check for valid modes by reading the properties translation dictionary with the functions mv.impact.acquire.EnumPropertyI<T>.getTranslationDictString and mv.impact.acquire.EnumPropertyI<T>.getTranslationDictValue. There is a more efficient function mv.impact.acquire.PropertyIPulseStartTrigger.getTranslationDict. in addition to the functions mentioned above.

triggerMoment

readonly EnumPropertyI<TTriggerMoment> triggerMoment = new EnumPropertyI<TTriggerMoment>()

An enumerated integer property defining the exact moment when this pulse start configuration shall be triggered.

Valid values for this property are defined by the enumeration mv.impact.acquire.TTriggerMoment.

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

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.

number

int number

get

Returns the internal number associated with this pulse start configuration.