Impact Acquire SDK Python
SyncOutput Class Reference

A class to represent a sync. More...

Inheritance diagram for SyncOutput:
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 getDescription (self)
 Returns a description for this sync.
 hObj (self)
 Returns a unique identifier for the component collection referenced by this object.
 restoreDefault (self)
 Restores the default for every component of this collection.

Properties

 description = property (getDescription, None, None, None)
 A string property (read-only) which holds a description for this sync.
 frequency_Hz = property(lib_mvIMPACT_acquire.SyncOutput_frequency_Hz_get, doc=)
 A float property defining the frequency(in Hertz) for the sync.
 lowPart_pc = property(lib_mvIMPACT_acquire.SyncOutput_lowPart_pc_get, doc=)
 A float property defining the width in percent the sync.
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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 mvIMPACT.acquire.IOSubSystem.
This class will only be available if mvIMPACT.acquire.Device.interfaceLayout is set to mvIMPACT.acquire.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args,
** kwargs )

Member Function Documentation

◆ getDescription()

getDescription ( self)

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

hObj ( self)
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()

restoreDefault ( self)
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.

Property Documentation

◆ description

description = property (getDescription, None, None, None)
static

A string property (read-only) which holds a description for this sync.

See mvIMPACT.acquire.SyncOutput.getDescription()

◆ frequency_Hz

frequency_Hz = property(lib_mvIMPACT_acquire.SyncOutput_frequency_Hz_get, doc=)
static

A float property defining the frequency(in Hertz) for the sync.

signal generated by this pin.

◆ lowPart_pc

lowPart_pc = property(lib_mvIMPACT_acquire.SyncOutput_lowPart_pc_get, doc=)
static

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.

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static