SyncOutput Class Reference

A class to represent a sync. output pin(Device specific interface layout only). More...

Inheritance diagram for SyncOutput:

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 PropertyF	frequency_Hz = new PropertyF()
	A float property defining the frequency(in Hertz) for the sync. signal generated by this pin.
readonly PropertyF	lowPart_pc = new PropertyF()
	A float property defining the width in percent the sync. signal stays low during one period. The output signal generated will be a square pulse.

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 description for this sync. output.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

Detailed Description

A class to represent a sync. output pin(Device specific interface layout only).

Instances of this class can be used to define and generate sync. signals at the corresponding outputs of the device.

Note

Instances of this class can't be constructed directly, but must be obtained via the device specific class derived from mv.impact.acquire.IOSubSystem.

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.

Examples

DigitalIOs.cs.

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 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

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

frequency_Hz

readonly PropertyF frequency_Hz = new PropertyF()

A float property defining the frequency(in Hertz) for the sync. signal generated by this pin.

Examples

DigitalIOs.cs.

lowPart_pc

readonly PropertyF lowPart_pc = new PropertyF()

A float property defining the width in percent the sync. signal stays low during one period. The output signal generated will be a square pulse.

Examples

DigitalIOs.cs.

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

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

Returns

An enumerator that iterates through the collection

description

String description

get

Returns a description for this sync. output.

This might contain connector descriptions or other information like e.g. 'VD-OUT(J9.24)', which means, this is the VD output at connector J9 pin 24.

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.