A class describing how a video signal source(e.g. More...

Inheritance diagram for Connector:

Public Member Functions
	Connector (Device pDev)
	Constructs a new mvIMPACT.acquire.Connector object.

	Connector (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.Connector object.

synchronized void	delete ()

PropertyI	getCameraOutputUsed ()
	An enumerated integer property defining the video signal output of the video signal source used for the connection to the video signal sink.

PropertyS	getPinDescription ()
	A string property (read-only) containing a description for the video channel currently selected by the property mvIMPACT.acquire.Connector.getVideoChannel().

PropertyI	getVideoChannel ()
	An integer property containing the video channel the camera belonging to the current setting is connected to.

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
	Connector (long cPtr, boolean cMemoryOwn)

void	finalize ()

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)

static long	swigRelease (Connector obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class describing how a video signal source(e.g.

a camera or image sensor) is connected to a video signal sink(e.g. a frame grabber)(Device specific interface layout only).

With an instance of this class the user can define on which input channels the video signal source used for this setting is connected to the video signal sink and how(in which format) the video signal source transmits its data.

Video signal source and video signal sink can both belong to the same physical piece of hardware. This e.g. might apply to a digital camera that doesn't need a frame grabber (e.g. a GigE Vision™, USB3 Vision™ or USB camera). In such a scenario certain properties belonging to this class might be read-only or may only allow a single enumeration value.

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

◆ Connector() [1/3]

Connector	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ Connector() [2/3]

Connector	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.Connector object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

◆ Connector() [3/3]

Connector ( Device pDev )

Constructs a new mvIMPACT.acquire.Connector object.

Parameters

pDev [in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

◆ getCameraOutputUsed()

PropertyI getCameraOutputUsed ( )

An enumerated integer property defining the video signal output of the video signal source used for the connection to the video signal sink.

Note: Not every video signal sink will support every possible value defined for this property. For example a CameraLink® frame grabber will not offer to use an SVideo connector. Therefore the translation dictionary of this property should be used to find out, which connector types are available.

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

Note: This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getPinDescription()

PropertyS getPinDescription ( )

A string property (read-only) containing a description for the video channel currently selected by the property mvIMPACT.acquire.Connector.getVideoChannel().

The description string contains information about the connector pins belonging to this video input of the video signal sink as well as the corresponding name of this video input.

Note: This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getVideoChannel()

PropertyI getVideoChannel ( )

An integer property containing the video channel the camera belonging to the current setting is connected to.

The maximum possible video channel might change when the property mvIMPACT.acquire.Connector.getCameraOutputUsed() is modified as the different ways to transmit a video signal require more or less video input channels. While e.g. a composite video signal can be transmitted via a single wire, an RGB signal requires either 3 or 4 wires (depending on whether the sync. signal is transmitted on a separate wire or not).

The first channel will always have the number 0. The limits (max/min values) can be queried by calling the function mvIMPACT.acquire.PropertyI.getMinValue or mvIMPACT.acquire.PropertyI.getMaxValue.

Note: This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ 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 ( Connector obj )

staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protectedinherited

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes