Connector Class Reference

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). More...

Inheritance diagram for Connector:

Public Member Functions
	Connector (Device device)
	Constructs a new mv.impact.acquire.Connector object.
	Connector (Device device, String settingName)
	Constructs a new mv.impact.acquire.Connector 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< TCameraOutput >	cameraOutputUsed = new EnumPropertyI<TCameraOutput>()
	An enumerated integer property defining the video signal output of the video signal source used for the connection to the video signal sink.
readonly PropertyS	pinDescription = new PropertyS()
	A string property (read-only) containing a description for the video channel currently selected by the property mv.impact.acquire.Connector.videoChannel.
readonly PropertyI	videoChannel = new PropertyI()
	An integer property containing the video channel the camera belonging to the current setting is connected to.

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

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™ 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 mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

Connector() [1/2]

Connector ( Device device )

inline

Constructs a new mv.impact.acquire.Connector object.

Parameters

[in]

device

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

Connector() [2/2]

Connector ( Device device, String settingName )

inline

Constructs a new mv.impact.acquire.Connector object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

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 frameworks 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 frameworks 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

cameraOutputUsed

readonly EnumPropertyI<TCameraOutput> cameraOutputUsed = new EnumPropertyI<TCameraOutput>()

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 mv.impact.acquire.TCameraOutput.

Note

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

pinDescription

readonly PropertyS pinDescription = new PropertyS()

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

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 mv.impact.acquire.Component.isValid to check if this property is available or not.

videoChannel

readonly PropertyI videoChannel = new PropertyI()

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 mv.impact.acquire.Connector.cameraOutputUsed 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 mv.impact.acquire.PropertyI.minValue or mv.impact.acquire.PropertyI.maxValue.

Note

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

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 frameworks 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 frameworks 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.