A class to describe a CameraLink® compliant camera(Device specific interface layout only) (deprecated. More...

#include <mvIMPACT_acquire.h>

Inheritance diagram for CameraDescriptionCameraLink:

Public Member Functions
int	copyDescription (const std::string &newName) const
	Creates a new camera description list as a copy of the current one.

int	exportDescription (void) const
	Stores the current camera description on disk.

std::string	getClassName (void) const
	Returns the class this description is belonging to.

HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.

int	importDescription (void) const
	Updates a camera description with the data stored in a previous session or with the original default data.

const ComponentCollection &	restoreDefault (void) const
	Restores the default for every component of this collection.

Public Attributes
PropertyI	aoiHeight
	An integer property defining the number of active lines to capture from the camera.

PropertyI	aoiStartX
	An integer property defining the X-offset in pixels to the first active pixel to capture.

PropertyI	aoiStartY
	An integer property defining the Y-offset in lines to the first active line to capture.

PropertyI	aoiWidth
	An integer property defining the number of active pixels to capture per line.

PropertyIBayerMosaicParity	bayerParity
	An enumerated integer property defining the start pixel for a camera delivering an unconverted bayer image.

PropertyI	bitsPerPixel
	An integer property defining the number of bits per pixel currently transmitted by this camera.

PropertyICameraLinkDataValidMode	dataValid
	An enumerated integer property defining the way this camera transmits the data valid (DVAL) signal.

PropertyICameraDataFormat	format
	An enumerated integer property defining the data format the camera is sending image data.

PropertyICameraInterlacedType	interlacedType
	An enumerated integer property defining how the camera transmits image data.

PropertyS	name
	A string property read-only containing the name of this camera description list.

PropertyI	pixelsPerCycle
	An integer property defining the number of pixels per clock cycle transmitted by this camera.

PropertyICameraScanMode	scanMode
	An enumerated integer property providing information about the sensor of this camera.

PropertyICameraTapsXGeometry	tapsXGeometry
	An enumerated integer property defining the way this camera transmits the pixel data in X direction.

PropertyICameraTapsYGeometry	tapsYGeometry
	An enumerated integer property defining the way this camera transmits the pixel data in Y direction.

PropertyICameraOutput	videoOutput
	An enumerated integer property defining the type of video outputs this camera offers.

Protected Attributes
HOBJ	m_hRoot

Friends
class	CameraDescriptionManager

Detailed Description

A class to describe a CameraLink® compliant camera(Device specific interface layout only) (deprecated.

Deprecated: Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

This class provides access to all settings specific for CameraLink® compliant cameras.

Note: This class will only be available if mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Member Function Documentation

◆ copyDescription()

int copyDescription ( const std::string & newName ) const

inlineinherited

Creates a new camera description list as a copy of the current one.

This function can be used to create a new camera description list. It will create a deep copy of the properties referenced by this camera description and will append the new description to the list of camera descriptions.

Note: This will NOT store the new description permanently. After the driver has been closed, this data will be lost. To store the new list in a way that it will be available the next time the driver/device is opened again, mvIMPACT::acquire::CameraDescriptionBase::exportDescription must be called with the handle of the newly created description after this function.

See also: mvIMPACT::acquire::CameraDescriptionBase::exportDescription,
mvIMPACT::acquire::CameraDescriptionBase::importDescription

Returns

mvIMPACT::acquire::DMR_NO_ERROR if successful.
mvIMPACT::acquire::DEV_INPUT_PARAM_INVALID if new name matches a description that is already existing.
A negative error code of type mvIMPACT::acquire::TDMR_ERROR or mvIMPACT::acquire::TPROPHANDLING_ERROR otherwise.

Parameters

[in] newName The name for the newly created camera description. This name MUST NOT match a description already existing.

◆ exportDescription()

int exportDescription ( void ) const

inlineinherited

Stores the current camera description on disk.

This function can be used to store the current settings of a camera description permanently so that the next time the driver is initialized these settings are restored.

When exporting a camera description a file in XML format will be written to disk.

On Windows® camera descriptions will be stored under PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)
On Unix based systems this directory will be /opt/ImpactAcquire/data/camerafiles
On other platforms these files will end up in the current working directory.

This behaviour can be modified by writing the property mvIMPACT::acquire::Device::customDataDirectory before initialising the device.

See also: mvIMPACT::acquire::CameraDescriptionBase::copyDescription,
mvIMPACT::acquire::CameraDescriptionBase::importDescription

Returns

mvIMPACT::acquire::DMR_NO_ERROR if successful.
A negative error code of type mvIMPACT::acquire::TDMR_ERROR or mvIMPACT::acquire::TPROPHANDLING_ERROR otherwise.

◆ getClassName()

std::string getClassName ( void ) const

inlineinherited

Returns the class this description is belonging to.

Returns: The class this description is belonging to.

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

◆ importDescription()

int importDescription ( void ) const

inlineinherited

Updates a camera description with the data stored in a previous session or with the original default data.

When importing a camera description the device driver will try to retrieve the parameters needed from a XML file.

On Windows® camera descriptions MUST be stored under PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)
n Unix based systems this directory will be /opt/ImpactAcquire/data/camerafiles
On other platforms these files MUST be located in the current working directory.

This behaviour can be modified by writing the property mvIMPACT::acquire::Device::customDataDirectory before initialising the device. To get access to an XML description file within the application, these file must be copied to this directory BEFORE the device is initialized. During the initialisation process the device driver will process every file located under this location and will add them to the internal list of descriptions. Every camera located during this process and also descriptions created later on during the program operation can be selected via the property mvIMPACT::acquire::CameraSettingsFrameGrabber::type.

Note: In order not to bloat the device driver with redundant data it's wise only to store the descriptions needed for the application to run under this location.; Only camera descriptions supported by the capture device will be added to the device drivers internal list and will therefore be accessible via the mvIMPACT::acquire::CameraDescriptionManager.

To restore the default values valid during the driver was initialized the function mvIMPACT::acquire::ComponentCollection::restoreDefault can be used as well.

See also: mvIMPACT::acquire::CameraDescriptionBase::exportDescription,
mvIMPACT::acquire::CameraDescriptionBase::copyDescription

Returns

mvIMPACT::acquire::DMR_NO_ERROR if successful.
A negative error code of type mvIMPACT::acquire::TDMR_ERROR or mvIMPACT::acquire::TPROPHANDLING_ERROR otherwise.

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

Friends And Related Symbol Documentation

◆ CameraDescriptionManager

friend class CameraDescriptionManager

friend

Member Data Documentation

◆ aoiHeight

PropertyI aoiHeight

inherited

An integer property defining the number of active lines to capture from the camera.

◆ aoiStartX

PropertyI aoiStartX

inherited

An integer property defining the X-offset in pixels to the first active pixel to capture.

◆ aoiStartY

PropertyI aoiStartY

inherited

An integer property defining the Y-offset in lines to the first active line to capture.

◆ aoiWidth

PropertyI aoiWidth

inherited

An integer property defining the number of active pixels to capture per line.

◆ bayerParity

PropertyIBayerMosaicParity bayerParity

inherited

An enumerated integer property defining the start pixel for a camera delivering an unconverted bayer image.

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

◆ bitsPerPixel

PropertyI bitsPerPixel

inherited

An integer property defining the number of bits per pixel currently transmitted by this camera.

◆ dataValid

PropertyICameraLinkDataValidMode dataValid

An enumerated integer property defining the way this camera transmits the data valid (DVAL) signal.

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

◆ format

PropertyICameraDataFormat format

inherited

An enumerated integer property defining the data format the camera is sending image data.

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

◆ interlacedType

PropertyICameraInterlacedType interlacedType

inherited

An enumerated integer property defining how the camera transmits image data.

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

◆ m_hRoot

HOBJ m_hRoot

protectedinherited

◆ name

PropertyS name

inherited

A string property read-only containing the name of this camera description list.

◆ pixelsPerCycle

PropertyI pixelsPerCycle

inherited

An integer property defining the number of pixels per clock cycle transmitted by this camera.

This corresponds the number of taps used by the camera in the described configuration.

◆ scanMode

PropertyICameraScanMode scanMode

inherited

An enumerated integer property providing information about the sensor of this camera.

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

◆ tapsXGeometry

PropertyICameraTapsXGeometry tapsXGeometry

An enumerated integer property defining the way this camera transmits the pixel data in X direction.

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

◆ tapsYGeometry

PropertyICameraTapsYGeometry tapsYGeometry

An enumerated integer property defining the way this camera transmits the pixel data in Y direction.

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

◆ videoOutput

PropertyICameraOutput videoOutput

inherited

An enumerated integer property defining the type of video outputs this camera offers.

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

Note: This property will be (read-only) for camera descriptions of type mvIMPACT::acquire::CameraDescriptionCameraLink and mvIMPACT::acquire::CameraDescriptionSDI as for these camera types the video output depends on certain other parameters according to the corresponding standard.

Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ copyDescription()

◆ exportDescription()

◆ getClassName()

◆ hObj()

◆ importDescription()

◆ restoreDefault()

Friends And Related Symbol Documentation

◆ CameraDescriptionManager

Member Data Documentation

◆ aoiHeight

◆ aoiStartX

◆ aoiStartY

◆ aoiWidth

◆ bayerParity

◆ bitsPerPixel

◆ dataValid

◆ format

◆ interlacedType

◆ m_hRoot

◆ name

◆ pixelsPerCycle

◆ scanMode

◆ tapsXGeometry

◆ tapsYGeometry

◆ videoOutput