DigitalIOMeasurementControl Class Reference

Properties for configuring settings belonging to the digital I/O measurement(Device specific interface layout only). More...

Inheritance diagram for DigitalIOMeasurementControl:

Public Member Functions
	DigitalIOMeasurementControl (Device device)
	brief Constructs a new mv.impact.acquire.DigitalIOMeasurementControl object.
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< TDigitalIOMeasurementMode >	digitalIOMeasurementMode = new EnumPropertyI<TDigitalIOMeasurementMode>()
	An enumerated integer property defining the type of measurement to perform.
readonly PropertyF	digitalIOMeasurementResult = new PropertyF()
	A float property (read-only) that will contain the result of the measurement.
readonly EnumPropertyI< TDigitalIOMeasurementMode >	digitalIOMeasurementSource = new EnumPropertyI<TDigitalIOMeasurementMode>()
	An enumerated integer property defining where the measurement shall be performed.

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.

Detailed Description

Properties for configuring settings belonging to the digital I/O measurement(Device specific interface layout only).

Properties in this class will only be available if a device offers digital I/O measurement features.

Example

// This code fragment will print result of measurement using all modes on all sources
// to the standard output.
DigitalIOMeasurementControl iomc = new DigitalIOMeasurementControl(getDevicePointerFromSomewhere());
if( iomc.digitalIOMeasurementMode.isValid && iomc.digitalIOMeasurementSource.isValid )
{
  List<KeyValuePair<String, TDigitalIOMeasurementMode>> modeDict = new List<KeyValuePair<string, TDigitalIOMeasurementMode>>();
  iomc.digitalIOMeasurementMode.getTranslationDict( modeDict );
  int modeCnt = iomc.digitalIOMeasurementMode.dictSize;
  List<KeyValuePair<String, TDigitalIOMeasurementSource>> srcDict = new List<KeyValuePair<string, TDigitalIOMeasurementSource>>();
  iomc.digitalIOMeasurementSource.getTranslationDict( srcDict );
  int srcCnt = iomc.digitalIOMeasurementSource.dictSize;
  for( int i=0; i<modeCnt; i++ )
  {
    iomc.digitalIOMeasurementMode.write( modeDict[i].Value );
    for( unsigned int j=0; j<srcCnt; j++ )
    {
      iomc.digitalIOMeasurementSource.write( srcDict[j].Value );
      Console.WriteLine( "Digital I/O measurement result using mode '{0}' at source '{1}': {2}\n", iomc.digitalIOMeasurementMode.readS(), iomc.digitalIOMeasurementSource.readS(), iomc.digitalIOMeasurementResult.readS() );
    }
  }
}

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.

Since

2.1.4

Constructor & Destructor Documentation

DigitalIOMeasurementControl()

DigitalIOMeasurementControl ( Device device )

inline

brief Constructs a new mv.impact.acquire.DigitalIOMeasurementControl object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

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

digitalIOMeasurementMode

readonly EnumPropertyI<TDigitalIOMeasurementMode> digitalIOMeasurementMode = new EnumPropertyI<TDigitalIOMeasurementMode>()

An enumerated integer property defining the type of measurement to perform.

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

digitalIOMeasurementResult

readonly PropertyF digitalIOMeasurementResult = new PropertyF()

A float property (read-only) that will contain the result of the measurement.

Reading this property will automatically perform a new measurement.

Note

Please note that the signal connected to the digital input must match the selected digital input threshold(see mv.impact.acquire.IOSubSystemBlueFOX.digitalInputThreshold) in order to obtain valid results.

digitalIOMeasurementSource

readonly EnumPropertyI<TDigitalIOMeasurementMode> digitalIOMeasurementSource = new EnumPropertyI<TDigitalIOMeasurementMode>()

An enumerated integer property defining where the measurement shall be performed.

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

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

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.