TriggerControl Class Reference

A class to configure the behaviour of trigger signals. More...

Inheritance diagram for TriggerControl:

Public Member Functions
synchronized void	delete ()
String	getDescription ()
	Returns a name of the trigger being configured.
PropertyI64	getTriggerActivation ()
	An enumerated 64 bit integer property that defines the start condition for the selected trigger.
PropertyF	getTriggerDelayAbs_us ()
	Specifies the absolute delay in microseconds (us) to apply after the trigger reception before.
PropertyI	getTriggerDelayLines ()
	Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.
PropertyI	getTriggerDivider ()
	An integer property used to divide the number of incoming trigger pulses by an integer factor.
PropertyI64	getTriggerMode ()
	Defines if the selected trigger is active.
PropertyI64	getTriggerOverlap ()
	Specifies the type trigger overlap permitted with the previous frame.
PropertyI64	getTriggerSource ()
	Defines the signal that will cause the trigger event.
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.
int	triggerSoftware ()
	Generates of software trigger command.

Protected Member Functions
void	finalize ()
	TriggerControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (TriggerControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class to configure the behaviour of trigger signals.

Features in this class will open up a more flexible way to configure certain trigger events for devices then the previous features('triggerInterface', 'triggerSource' and 'triggerMode' used.

Note

Not ever device will support every property listed in this class for every trigger mode. Always call mvIMPACT.acquire.Component.isValid to check whether a feature is available or not before using it. Otherwise an exception will be generated.

Constructor & Destructor Documentation

TriggerControl()

TriggerControl ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getDescription()

String getDescription

(

)

Returns a name of the trigger being configured.

getTriggerActivation()

PropertyI64 getTriggerActivation

(

)

An enumerated 64 bit integer property that defines the start condition for the selected trigger.

Valid value will be 'RisingEdge', 'FallingEdge', 'AnyEdge', 'LevelLow' or 'LevelHigh'.

getTriggerDelayAbs_us()

PropertyF getTriggerDelayAbs_us

(

)

Specifies the absolute delay in microseconds (us) to apply after the trigger reception before.

effectively activating it.

getTriggerDelayLines()

PropertyI getTriggerDelayLines

(

)

Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.

getTriggerDivider()

PropertyI getTriggerDivider

(

)

An integer property used to divide the number of incoming trigger pulses by an integer factor.

E.g. setting this value to 2 would generate 5 internal trigger events from a 10 Hz external signal.

getTriggerMode()

PropertyI64 getTriggerMode

(

)

Defines if the selected trigger is active.

getTriggerOverlap()

PropertyI64 getTriggerOverlap

(

)

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted (or latched) for a new frame. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDeviceTriggerOverlap.

getTriggerSource()

PropertyI64 getTriggerSource

(

)

Defines the signal that will cause the trigger event.

Currently this property will define a translation dictionary that can e.g. be queried via a call to mvIMPACT.acquire.PropertyI64.getTranslationDict. The resulting translation dictionary can be used to select the desired trigger source either via a string or the associated 64 bit integer value.

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

staticprotected

triggerSoftware()

int triggerSoftware

(

)

Generates of software trigger command.

Returns

• mvIMPACT.acquire.TDMR_ERROR.DMR_NO_ERROR if successful.
• A negative error code of type mvIMPACT.acquire.TDMR_ERROR otherwise.

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited