mvIMPACT Acquire SDK C++
CameraDescriptionStandardBase Class Reference

An internal base class to describe standard analogue video cameras(Device specific interface layout only). More...

Inheritance diagram for CameraDescriptionStandardBase:
CameraDescriptionBase ComponentCollection CameraDescriptionNonStandard CameraDescriptionStandard

Public Member Functions

int copyDescription (const std::string &newName) const
 Creates a new camera description list as a copy of the current one. More...
 
int exportDescription (void) const
 Stores the current camera description on disc. More...
 
std::string getClassName (void) const
 Returns the class this description is belonging to. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
int importDescription (void) const
 Updates a camera description with the data stored in a previous session or with the original default data. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI aoiHeight
 An integer property defining the number of active lines to capture from the camera. More...
 
PropertyI aoiStartX
 An integer property defining the X-offset in pixels to the first active pixel to capture. More...
 
PropertyI aoiStartY
 An integer property defining the Y-offset in lines to the first active line to capture. More...
 
PropertyI aoiWidth
 An integer property defining the number of active pixels to capture per line. More...
 
PropertyICameraInterlacedType interlacedType
 An enumerated integer property defining how the camera transmits image data. More...
 
PropertyS name
 A string property read-only containing the name of this camera description list. More...
 
PropertyI scanRate_kHz
 An integer property containing the scan rate in kHz needed to driver the AD converter of the capture device with to convert the video signal properly. More...
 
PropertyIScanStandard scanStandard
 An enumerated integer property defining the scan standard this camera is compliant with. More...
 
PropertyIAcquisitionField startField
 An enumerated integer property containing information about the first field transmitted by a camera. More...
 
PropertyICameraOutput videoOutput
 An enumerated integer property defining the type of video outputs this camera offers. More...
 
PropertyIVideoStandard videoStandard
 An enumerated integer property for defining the video standard this camera is compliant with. More...
 

Protected Member Functions

 CameraDescriptionStandardBase (HDRV hDrv, HLIST hList)
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

An internal base class to describe standard analogue video cameras(Device specific interface layout only).

Instances of this class can't be constructed directly. Use one of the derived types.

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

◆ CameraDescriptionStandardBase()

CameraDescriptionStandardBase ( HDRV  hDrv,
HLIST  hList 
)
inlineexplicitprotected

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
Parameters
[in]newNameThe 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 disc.

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 disc. On Windows® camera descriptions will be stored under

%ALLUSERS%/Documents/MATRIX VISION/mvIMPACT acquire/CameraFiles
Definition: mvIMPACT_acquire.h:154

or

%MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles

which will point to the same folder), on Linux® this directory will be

/etc/matrix-vision/mvimpact-acquire/camerafiles

while under 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

◆ 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

%ALLUSERS%/Documents/MATRIX VISION/mvIMPACT acquire/CameraFiles

or

%MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles

which will point to the same folder), under Linux® this directory will be

/etc/matrix-vision/mvimpact-acquire/camerafiles

while under 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 a 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

◆ 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

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

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

◆ scanRate_kHz

PropertyI scanRate_kHz

An integer property containing the scan rate in kHz needed to driver the AD converter of the capture device with to convert the video signal properly.

◆ scanStandard

PropertyIScanStandard scanStandard

An enumerated integer property defining the scan standard this camera is compliant with.

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

◆ startField

An enumerated integer property containing information about the first field transmitted by a camera.

A camera might transmit either the odd or the even field of an interlaced video signal first.

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

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

◆ videoStandard

PropertyIVideoStandard videoStandard

An enumerated integer property for defining the video standard this camera is compliant with.

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


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