mvIMPACT Acquire SDK C++
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:
ComponentCollection

Public Member Functions

 Connector (Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::Connector object. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyICameraOutput cameraOutputUsed
 An enumerated integer property defining the video signal output of the video signal source used for the connection to the video signal sink. More...
 
PropertyS pinDescription
 A string property (read-only) containing a description for the video channel currently selected by the property mvIMPACT::acquire::Connector::videoChannel. More...
 
PropertyI videoChannel
 An integer property containing the video channel the camera belonging to the current setting is connected to. More...
 

Protected Attributes

HOBJ m_hRoot
 

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::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ Connector()

Connector ( Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::Connector object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

const ComponentCollection& restoreDefault ( void  ) const
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.
Returns
A const reference to the component.

Member Data Documentation

◆ cameraOutputUsed

PropertyICameraOutput cameraOutputUsed

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.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ pinDescription

PropertyS pinDescription

A string property (read-only) containing a description for the video channel currently selected by the property mvIMPACT::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 mvIMPACT::acquire::Component::isValid to check if this property is available or not.

◆ videoChannel

PropertyI videoChannel

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

The documentation for this class was generated from the following file: