Impact Acquire SDK Java
DigitalIOMeasurementControl Class Reference

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

Inheritance diagram for DigitalIOMeasurementControl:
[legend]

Public Member Functions

synchronized void delete ()
 
 DigitalIOMeasurementControl (Device pDev)
 brief Constructs a new mvIMPACT.acquire.DigitalIOMeasurementControl object.
 
PropertyI getDigitalIOMeasurementMode ()
 An enumerated integer property defining the type of measurement to perform.
 
PropertyF getDigitalIOMeasurementResult ()
 A float property (read-only) that will contain the result of the measurement.
 
PropertyI getDigitalIOMeasurementSource ()
 An enumerated integer property defining where the measurement shall be performed.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 

Protected Member Functions

 DigitalIOMeasurementControl (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
 
static long swigRelease (DigitalIOMeasurementControl obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

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.

// 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() )
{
StringIntVector modeDict = new StringIntVector();
iomc.digitalIOMeasurementMode.getTranslationDict( modeDict );
final int modeCnt = iomc.digitalIOMeasurementMode.dictSize();
iomc.digitalIOMeasurementSource.getTranslationDict( srcDict );
final int srcCnt = iomc.digitalIOMeasurementSource.dictSize();
for( int i=0; i<modeCnt; i++ )
{
iomc.digitalIOMeasurementMode.write( modeDict.get( i ).getSecond() );
for( int j=0; j<srcCnt; j++ )
{
iomc.digitalIOMeasurementSource.write( srcDict.get( j ).getSecond() );
System.out.println( String.format( "Digital I/O measurement result using mode '%s' at source '%s': %s\n", iomc.digitalIOMeasurementMode.readS(), iomc.digitalIOMeasurementSource.readS(), iomc.digitalIOMeasurementResult.readS() ) );
}
}
}
Properties for configuring settings belonging to the digital I/O measurement(Device specific interfac...
Definition DigitalIOMeasurementControl.java:86
int getSecond()
Definition StringIntPair.java:75
Definition StringIntVector.java:11
StringIntPair get(int index)
Definition StringIntVector.java:67
Note
This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ DigitalIOMeasurementControl() [1/2]

DigitalIOMeasurementControl ( long cPtr,
boolean cMemoryOwn )
protected

◆ DigitalIOMeasurementControl() [2/2]

brief Constructs a new mvIMPACT.acquire.DigitalIOMeasurementControl object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )
protected

Reimplemented from ComponentCollection.

◆ getDigitalIOMeasurementMode()

PropertyI getDigitalIOMeasurementMode ( )

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

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

◆ getDigitalIOMeasurementResult()

PropertyF getDigitalIOMeasurementResult ( )

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 mvIMPACT.acquire.IOSubSystemBlueFOX.getDigitalInputThreshold()) in order to obtain valid results.

◆ getDigitalIOMeasurementSource()

PropertyI getDigitalIOMeasurementSource ( )

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

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

◆ hObj()

int hObj ( )
inherited

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

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

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

◆ restoreDefault()

ComponentCollection restoreDefault ( )
inherited

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.
Returns
A const reference to the component.

◆ swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj)
staticprotectedinherited

◆ swigRelease() [2/2]

static long swigRelease ( DigitalIOMeasurementControl obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited