mvIMPACT Acquire SDK C++
|
An internal base class to describe standard analogue video cameras(Device specific interface layout only). More...
#include <mvIMPACT_acquire.h>
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 disc. | |
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. | |
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 | 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. | |
PropertyIScanStandard | scanStandard |
An enumerated integer property defining the scan standard this camera is compliant with. | |
PropertyIAcquisitionField | startField |
An enumerated integer property containing information about the first field transmitted by a camera. | |
PropertyICameraOutput | videoOutput |
An enumerated integer property defining the type of video outputs this camera offers. | |
PropertyIVideoStandard | videoStandard |
An enumerated integer property for defining the video standard this camera is compliant with. | |
Protected Member Functions | |
CameraDescriptionStandardBase (HDRV hDrv, HLIST hList) | |
Protected Attributes | |
HOBJ | m_hRoot |
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.
|
inlineexplicitprotected |
|
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.
[in] | newName | The name for the newly created camera description. This name MUST NOT match a description already existing. |
|
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
or
which will point to the same folder), on Linux® this directory will be
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.
|
inlineinherited |
Returns the class this description is belonging to.
|
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.
|
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 an XML file. On Windows® camera descriptions MUST be stored under
or
which will point to the same folder), under Linux® this directory will be
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 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.
To restore the default values valid during the driver was initialized the function mvIMPACT::acquire::ComponentCollection::restoreDefault can be used as well.
|
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.
|
inherited |
An integer property defining the number of active lines to capture from the camera.
|
inherited |
An integer property defining the X-offset in pixels to the first active pixel to capture.
|
inherited |
An integer property defining the Y-offset in lines to the first active line to capture.
|
inherited |
An integer property defining the number of active pixels to capture per line.
|
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.
|
protectedinherited |
|
inherited |
A string property read-only containing the name of this camera description list.
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.
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.
PropertyIAcquisitionField 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.
|
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.
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.