FLImaging 7.10.21.1
FLImagingDevices/DeviceCameraMatrox.h
1#pragma once
11
12#include "DeviceCameraBase.h"
13#include "DeviceCameraFeatureBase.h"
14
15
17namespace FLImaging
18{
20 namespace Devices
21 {
22 class CInternalDeviceCameraMatrox;
23
34 {
35 public:
36
45 {
50
55
60
65
70
75
80
85
90
95
100
105
110
115
120
125 };
126
135 {
140
145
150
155
160
165
170
175
180
185
190
195
200
205
210
215
220
225
230
235
240
245
250
255
260
265
270
275
280
285
290
295
300
305
310
315
320
325
330
335
340
345
350
355
360
365
370
375 };
376
377 public:
385
393
394 virtual const CResult Initialize() override;
395 virtual const CResult Terminate() override;
396
397 virtual const CResult Grab() override;
398 virtual const CResult Live() override;
399 virtual const CResult Stop() override;
400
401 virtual const CResult TriggerWithSoftware() override;
402
418 virtual const CResult SetDeviceType(EDeviceType eType);
419
431 virtual EDeviceType GetDeviceType() const;
432
446 virtual const CResult SetDeviceIndex(int32_t i32DeviceIndex);
447
457 virtual int32_t GetDeviceIndex() const;
458
472 virtual const CResult SetModuleIndex(int32_t i32ModuleIndex);
473
483 virtual int32_t GetModuleIndex() const;
484
500 virtual const CResult SetCamFilePath(const Base::CFLString<wchar_t>& flsCamFilePath);
501
514
515
516
530 virtual const CResult SetExposureTime(double f64Exposure);
531
545 virtual const CResult GetExposureTime(double* pF64Exposure) const;
546
560 virtual const CResult GetExposureTime(double& f64Exposure) const;
561
575 virtual const CResult SetGain(int64_t i64Gain);
576
590 virtual const CResult GetGain(int64_t* pI64Gain) const;
591
605 virtual const CResult GetGain(int64_t& i64Gain) const;
606
607
621 virtual const CResult SetTriggerMode(bool bOn);
622
636 virtual const CResult GetTriggerMode(bool* pOn) const;
637
651 virtual const CResult GetTriggerMode(bool& bOn) const;
652
669
685 virtual const CResult GetTriggerSource(ETriggerSource* pSource) const;
686
702 virtual const CResult GetTriggerSource(ETriggerSource& eSource) const;
703
705 virtual const CResult SetBoolValue(const char* pszKey, const bool* pBValue) override;
706 virtual const CResult SetBoolValue(const wchar_t* pWcsKey, const bool* pBValue) override;
707
709 virtual const CResult GetBoolValue(const char* pszKey, bool* pBValue) const override;
710 virtual const CResult GetBoolValue(const wchar_t* pWcsKey, bool* pBValue) const override;
711
713 virtual const CResult SetInt32Value(const char* pszKey, const int32_t* pI32Value) override;
714
716 virtual const CResult GetInt32Value(const char* pszKey, int32_t* pI32Value) const override;
717
719 virtual const CResult SetInt64Value(const char* pszKey, const int64_t* pI64Value) override;
720 virtual const CResult SetInt64Value(const wchar_t* pWcsKey, const int64_t* pI64Value) override;
721
723 virtual const CResult GetInt64Value(const char* pszKey, int64_t* pI64Value) const override;
724 virtual const CResult GetInt64Value(const wchar_t* pWcsKey, int64_t* pI64Value) const override;
725
727 virtual const CResult SetFloatValue(const char* pszKey, const float* pF32Value) override;
728
730 virtual const CResult GetFloatValue(const char* pszKey, float* pF32Value) const override;
731
733 virtual const CResult SetDoubleValue(const char* pszKey, const double* pF64Value) override;
734 virtual const CResult SetDoubleValue(const wchar_t* pWcsKey, const double* pF64Value) override;
735
737 virtual const CResult GetDoubleValue(const char* pszKey, double* pF64Value) const override;
738 virtual const CResult GetDoubleValue(const wchar_t* pWcsKey, double* pF64Value) const override;
739
741 virtual const CResult SetStringValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
742 virtual const CResult SetStringValue(const wchar_t* pWcsKey, const Base::CFLString<wchar_t>* pFlsValue) override;
743
745 virtual const CResult GetStringValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
746 virtual const CResult GetStringValue(const wchar_t* pWcsKey, Base::CFLString<wchar_t>* pFlsValue) const override;
747
748 DeclareGetClassType();
749
750 protected:
751 virtual bool CheckDeviceLibraries() const override;
752
753 virtual const CResult AllocApp();
754 virtual const CResult DeallocApp();
755
756 virtual const CResult AllocSystem();
757 virtual const CResult DeallocSystem();
758
759 private:
761 virtual const CResult SetEnumValue(const char* pszKey, const int32_t* pI32Value) override;
762 virtual const CResult SetEnumValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
763
765 virtual const CResult GetEnumValue(const char* pszKey, int32_t* pI32Value) const override;
766 virtual const CResult GetEnumValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
767
769 virtual const CResult GetEnumFeatureEntries(const Base::CFLString<wchar_t>& flsFeature, std::vector<std::pair<int32_t, Base::CFLString<wchar_t>>>* pVctEntries) const override;
770
772 virtual const CResult ExecuteCommand(const char* pszKey) const override;
773
774
775 protected:
776 CInternalDeviceCameraMatrox* m_pInternal;
777
778 friend class CInternalDeviceCameraMatrox;
779 };
780 }
781}
782
783
Template type string class.
Definition FLString.h:34
FLImaging module execution result object.
Definition FLImagingBase/ResultsDef.h:1712
CDeviceCameraBase()
Default constructor.
virtual const CResult GetBoolValue(const char *pszKey, bool &bValue) const
Retrieves a boolean value from the device using a key (UTF-8 string).
virtual const CResult SetFloatValue(const char *pszKey, const float &f32Value)
Sets a single-precision floating point value on the device using a UTF-8 key.
virtual const CResult SetDoubleValue(const char *pszKey, const double &f64Value)
Sets a double-precision floating point value on the device using a UTF-8 key.
virtual const CResult GetInt64Value(const char *pszKey, int64_t &i64Value) const
Retrieves a 64-bit integer (Int64) value from the device using a UTF-8 key.
virtual const CResult GetStringValue(const char *pszKey, Base::CFLString< char > &strValue) const
Retrieves a string value from the device using a UTF-8 key.
virtual const CResult SetEnumValue(const char *pszKey, const int32_t &i32Value)
Sets an enum value on the device using a UTF-8 key.
virtual const CResult SetStringValue(const char *pszKey, const Base::CFLString< char > &strValue)
Sets a string value on the device using a UTF-8 key and narrow string.
virtual const CResult GetEnumValue(const char *pszKey, int32_t &i32Value) const
Retrieves an enum value from the device using a UTF-8 key.
virtual const CResult SetInt32Value(const char *pszKey, const int32_t &i32Value)
Sets a 32-bit integer (Int32) value on the device using a UTF-8 key.
virtual const CResult SetBoolValue(const char *pszKey, const bool &bValue)
Sets a boolean value on the device using a key (UTF-8 string).
virtual const CResult SetInt64Value(const char *pszKey, const int64_t &i64Value)
Sets a 64-bit integer (Int64) value on the device using a UTF-8 key.
virtual const CResult GetFloatValue(const char *pszKey, float &f32Value) const
Retrieves a single-precision floating point value from the device using a UTF-8 key.
virtual const CResult GetDoubleValue(const char *pszKey, double &f64Value) const
Retrieves a double-precision floating point value from the device using a UTF-8 key.
virtual const CResult ExecuteCommand(const char *pszKey) const =0
Executes a command on the device using a key.
virtual const CResult GetEnumFeatureEntries(const Base::CFLString< wchar_t > &flsFeature, std::vector< std::pair< int32_t, Base::CFLString< wchar_t > > > &vctEntries) const
Retrieves the enumeration entries of the specified feature.
virtual const CResult GetInt32Value(const char *pszKey, int32_t &i32Value) const
Retrieves a 32-bit integer (Int32) value from the device using a UTF-8 key.
virtual const CResult GetDoubleValue(const wchar_t *pWcsKey, double *pF64Value) const override
Retrieves a double-precision floating point value from the device using a wide-character key.
virtual const CResult SetModuleIndex(int32_t i32ModuleIndex)
Sets the index for the module.
EDeviceType
Device Type.
Definition FLImagingDevices/DeviceCameraMatrox.h:45
@ EDeviceType_Indio
MIL Indio system.
Definition FLImagingDevices/DeviceCameraMatrox.h:84
@ EDeviceType_ClarityUHD
MIL Clarity UHD system.
Definition FLImagingDevices/DeviceCameraMatrox.h:54
@ EDeviceType_GevIQ
MIL GevIQ system.
Definition FLImagingDevices/DeviceCameraMatrox.h:69
@ EDeviceType_ConcordPOE
MIL Concord POE system.
Definition FLImagingDevices/DeviceCameraMatrox.h:59
@ EDeviceType_RapixoCXP
Rapixo CXP system.
Definition FLImagingDevices/DeviceCameraMatrox.h:114
@ EDeviceType_IrisGTX
Iris GTX system.
Definition FLImagingDevices/DeviceCameraMatrox.h:89
@ EDeviceType_Solios
Solios system.
Definition FLImagingDevices/DeviceCameraMatrox.h:119
@ EDeviceType_GigE
MIL GigE Vision system.
Definition FLImagingDevices/DeviceCameraMatrox.h:74
@ EDeviceType_GenTL
MIL GenTL system.
Definition FLImagingDevices/DeviceCameraMatrox.h:64
@ EDeviceType_Host
Host.
Definition FLImagingDevices/DeviceCameraMatrox.h:79
@ EDeviceType_Morphis
Morphis system.
Definition FLImagingDevices/DeviceCameraMatrox.h:94
@ EDeviceType_USB3
USB3 Vision system.
Definition FLImagingDevices/DeviceCameraMatrox.h:124
@ EDeviceType_Radient_eV_CL
Radient eV-CL system.
Definition FLImagingDevices/DeviceCameraMatrox.h:104
@ EDeviceType_RapixoProCL
Rapixo Pro CL system.
Definition FLImagingDevices/DeviceCameraMatrox.h:109
@ EDeviceType_Radient_eV_CXP
Radient eV-CXP system.
Definition FLImagingDevices/DeviceCameraMatrox.h:99
@ EDeviceType_Unknown
Unknown type.
Definition FLImagingDevices/DeviceCameraMatrox.h:49
virtual const CResult SetStringValue(const wchar_t *pWcsKey, const Base::CFLString< wchar_t > *pFlsValue) override
Sets a wide-character string value on the device using a wide-character key and pointer to value.
virtual const CResult GetTriggerMode(bool &bOn) const
Gets the trigger mode of the camera.
virtual const CResult GetStringValue(const char *pszKey, Base::CFLString< char > *pFlsValue) const override
Retrieves a string value from the device using a UTF-8 key.
virtual const CResult GetBoolValue(const wchar_t *pWcsKey, bool *pBValue) const override
Retrieves a boolean value from the device using a key (Unicode string).
virtual const CResult GetFloatValue(const char *pszKey, float *pF32Value) const override
Retrieves a single-precision floating point value from the device using a UTF-8 key.
virtual const CResult Initialize() override
Initialize the device.
virtual const CResult SetTriggerMode(bool bOn)
Sets the trigger mode for the camera.
virtual Base::CFLString< wchar_t > GetCamFilePath() const
Gets the path to the set camera file.
virtual const CResult Terminate() override
Terminate the device.
virtual const CResult GetBoolValue(const char *pszKey, bool *pBValue) const override
Retrieves a boolean value from the device using a key (UTF-8 string).
virtual EDeviceType GetDeviceType() const
Gets the type of device set.
virtual const CResult GetInt32Value(const char *pszKey, int32_t *pI32Value) const override
Retrieves a 32-bit integer (Int32) value from the device using a UTF-8 key.
virtual const CResult Stop() override
Stops image acquisition.
virtual const CResult Live() override
Starts live image acquisition.
virtual const CResult SetDoubleValue(const char *pszKey, const double *pF64Value) override
Sets a double-precision floating point value on the device using a UTF-8 key.
virtual const CResult SetTriggerSource(ETriggerSource eSource)
Sets the trigger source for the camera.
virtual const CResult SetDoubleValue(const wchar_t *pWcsKey, const double *pF64Value) override
Sets a double-precision floating point value on the device using a wide-character key.
ETriggerSource
Trigger source.
Definition FLImagingDevices/DeviceCameraMatrox.h:135
@ ETriggerSource_Null
No trigger source.
Definition FLImagingDevices/DeviceCameraMatrox.h:144
@ ETriggerSource_AuxIO14
Auxiliary input signal 14.
Definition FLImagingDevices/DeviceCameraMatrox.h:289
@ ETriggerSource_Timer1
Timer 1.
Definition FLImagingDevices/DeviceCameraMatrox.h:199
@ ETriggerSource_AuxIO27
Auxiliary input signal 27.
Definition FLImagingDevices/DeviceCameraMatrox.h:354
@ ETriggerSource_RotaryEncoder3
Rotary decoder 3.
Definition FLImagingDevices/DeviceCameraMatrox.h:189
@ ETriggerSource_Timer2
Timer 2.
Definition FLImagingDevices/DeviceCameraMatrox.h:204
@ ETriggerSource_AuxIO4
Auxiliary input signal 4.
Definition FLImagingDevices/DeviceCameraMatrox.h:239
@ ETriggerSource_AuxIO29
Auxiliary input signal 29.
Definition FLImagingDevices/DeviceCameraMatrox.h:364
@ ETriggerSource_RotaryEncoder1
Rotary decoder 1.
Definition FLImagingDevices/DeviceCameraMatrox.h:179
@ ETriggerSource_AuxIO2
Auxiliary input signal 2.
Definition FLImagingDevices/DeviceCameraMatrox.h:229
@ ETriggerSource_AuxIO13
Auxiliary input signal 13.
Definition FLImagingDevices/DeviceCameraMatrox.h:284
@ ETriggerSource_AuxIO15
Auxiliary input signal 15.
Definition FLImagingDevices/DeviceCameraMatrox.h:294
@ ETriggerSource_AuxIO28
Auxiliary input signal 28.
Definition FLImagingDevices/DeviceCameraMatrox.h:359
@ ETriggerSource_AuxIO25
Auxiliary input signal 25.
Definition FLImagingDevices/DeviceCameraMatrox.h:344
@ ETriggerSource_AuxIO31
Auxiliary input signal 31.
Definition FLImagingDevices/DeviceCameraMatrox.h:374
@ ETriggerSource_AuxIO9
Auxiliary input signal 9.
Definition FLImagingDevices/DeviceCameraMatrox.h:264
@ ETriggerSource_AuxIO12
Auxiliary input signal 12.
Definition FLImagingDevices/DeviceCameraMatrox.h:279
@ ETriggerSource_AuxIO5
Auxiliary input signal 5.
Definition FLImagingDevices/DeviceCameraMatrox.h:244
@ ETriggerSource_RotaryEncoder
Default rotary decoder.
Definition FLImagingDevices/DeviceCameraMatrox.h:174
@ ETriggerSource_AuxIO21
Auxiliary input signal 21.
Definition FLImagingDevices/DeviceCameraMatrox.h:324
@ ETriggerSource_AuxIO17
Auxiliary input signal 17.
Definition FLImagingDevices/DeviceCameraMatrox.h:304
@ ETriggerSource_AuxIO16
Auxiliary input signal 16.
Definition FLImagingDevices/DeviceCameraMatrox.h:299
@ ETriggerSource_Software3
Software trigger being used for the grab of another digitizer 3.
Definition FLImagingDevices/DeviceCameraMatrox.h:164
@ ETriggerSource_AuxIO26
Auxiliary input signal 26.
Definition FLImagingDevices/DeviceCameraMatrox.h:349
@ ETriggerSource_AuxIO22
Auxiliary input signal 22.
Definition FLImagingDevices/DeviceCameraMatrox.h:329
@ ETriggerSource_AuxIO23
Auxiliary input signal 23.
Definition FLImagingDevices/DeviceCameraMatrox.h:334
@ ETriggerSource_Software1
Software trigger being used for the grab of another digitizer 1.
Definition FLImagingDevices/DeviceCameraMatrox.h:154
@ ETriggerSource_AuxIO6
Auxiliary input signal 6.
Definition FLImagingDevices/DeviceCameraMatrox.h:249
@ ETriggerSource_AuxIO0
Auxiliary input signal 0.
Definition FLImagingDevices/DeviceCameraMatrox.h:219
@ ETriggerSource_AuxIO30
Auxiliary input signal 30.
Definition FLImagingDevices/DeviceCameraMatrox.h:369
@ ETriggerSource_Default
Specified by the DCF.
Definition FLImagingDevices/DeviceCameraMatrox.h:139
@ ETriggerSource_Software
Software.
Definition FLImagingDevices/DeviceCameraMatrox.h:149
@ ETriggerSource_AuxIO24
Auxiliary input signal 24.
Definition FLImagingDevices/DeviceCameraMatrox.h:339
@ ETriggerSource_RotaryEncoder4
Rotary decoder 4.
Definition FLImagingDevices/DeviceCameraMatrox.h:194
@ ETriggerSource_AuxIO11
Auxiliary input signal 11.
Definition FLImagingDevices/DeviceCameraMatrox.h:274
@ ETriggerSource_AuxIO10
Auxiliary input signal 10.
Definition FLImagingDevices/DeviceCameraMatrox.h:269
@ ETriggerSource_Timer4
Timer 4.
Definition FLImagingDevices/DeviceCameraMatrox.h:214
@ ETriggerSource_Software2
Software trigger being used for the grab of another digitizer 2.
Definition FLImagingDevices/DeviceCameraMatrox.h:159
@ ETriggerSource_AuxIO7
Auxiliary input signal 7.
Definition FLImagingDevices/DeviceCameraMatrox.h:254
@ ETriggerSource_Timer3
Timer 3.
Definition FLImagingDevices/DeviceCameraMatrox.h:209
@ ETriggerSource_AuxIO19
Auxiliary input signal 19.
Definition FLImagingDevices/DeviceCameraMatrox.h:314
@ ETriggerSource_AuxIO8
Auxiliary input signal 8.
Definition FLImagingDevices/DeviceCameraMatrox.h:259
@ ETriggerSource_RotaryEncoder2
Rotary decoder 2.
Definition FLImagingDevices/DeviceCameraMatrox.h:184
@ ETriggerSource_AuxIO3
Auxiliary input signal 3.
Definition FLImagingDevices/DeviceCameraMatrox.h:234
@ ETriggerSource_AuxIO20
Auxiliary input signal 20.
Definition FLImagingDevices/DeviceCameraMatrox.h:319
@ ETriggerSource_AuxIO18
Auxiliary input signal 18.
Definition FLImagingDevices/DeviceCameraMatrox.h:309
@ ETriggerSource_Software4
Software trigger being used for the grab of another digitizer 4.
Definition FLImagingDevices/DeviceCameraMatrox.h:169
@ ETriggerSource_AuxIO1
Auxiliary input signal 1.
Definition FLImagingDevices/DeviceCameraMatrox.h:224
virtual const CResult SetBoolValue(const wchar_t *pWcsKey, const bool *pBValue) override
Sets a boolean value on the device using a key (Unicode string).
virtual int32_t GetModuleIndex() const
Gets the index of the set module.
virtual const CResult SetBoolValue(const char *pszKey, const bool *pBValue) override
Sets a boolean value on the device using a key (UTF-8 string).
virtual int32_t GetDeviceIndex() const
Gets the index of the set device.
virtual const CResult SetCamFilePath(const Base::CFLString< wchar_t > &flsCamFilePath)
Sets the path to the camera file.
virtual const CResult SetFloatValue(const char *pszKey, const float *pF32Value) override
Sets a single-precision floating point value on the device using a UTF-8 key.
virtual const CResult SetInt64Value(const wchar_t *pWcsKey, const int64_t *pI64Value) override
Sets a 64-bit integer (Int64) value on the device using a wide-character key.
virtual ~CDeviceCameraMatrox()
Default destructor.
virtual const CResult GetGain(int64_t &i64Gain) const
Gets the gain of the camera.
virtual const CResult GetStringValue(const wchar_t *pWcsKey, Base::CFLString< wchar_t > *pFlsValue) const override
Retrieves a wide-character string value from the device using a wide-character key.
virtual const CResult GetTriggerSource(ETriggerSource &eSource) const
Gets the trigger source of the camera.
virtual const CResult GetExposureTime(double &f64Exposure) const
Gets the exposure time of the camera.
virtual const CResult SetInt64Value(const char *pszKey, const int64_t *pI64Value) override
Sets a 64-bit integer (Int64) value on the device using a UTF-8 key.
virtual const CResult GetTriggerSource(ETriggerSource *pSource) const
Gets the trigger source of the camera.
virtual const CResult GetExposureTime(double *pF64Exposure) const
Gets the exposure time of the camera.
virtual const CResult SetExposureTime(double f64Exposure)
Sets the exposure time for the camera.
virtual const CResult GetGain(int64_t *pI64Gain) const
Gets the gain of the camera.
virtual const CResult SetDeviceIndex(int32_t i32DeviceIndex)
Sets the index for the device.
virtual const CResult GetTriggerMode(bool *pOn) const
Gets the trigger mode of the camera.
virtual const CResult Grab() override
Acquires a single image from the device.
virtual const CResult TriggerWithSoftware() override
Executes a software trigger on the device.
virtual const CResult GetDoubleValue(const char *pszKey, double *pF64Value) const override
Retrieves a double-precision floating point value from the device using a UTF-8 key.
virtual const CResult SetDeviceType(EDeviceType eType)
Sets the type of device.
virtual const CResult SetInt32Value(const char *pszKey, const int32_t *pI32Value) override
Sets a 32-bit integer (Int32) value on the device using a UTF-8 key.
virtual const CResult SetGain(int64_t i64Gain)
Set the gain of the camera.
CDeviceCameraMatrox()
Default constructor.
virtual const CResult SetStringValue(const char *pszKey, const Base::CFLString< char > *pFlsValue) override
Sets a string value on the device using a UTF-8 key and pointer to narrow string.
virtual const CResult GetInt64Value(const wchar_t *pWcsKey, int64_t *pI64Value) const override
Retrieves a 64-bit integer (Int64) value from the device using a wide-character key.
virtual const CResult GetInt64Value(const char *pszKey, int64_t *pI64Value) const override
Retrieves a 64-bit integer (Int64) value from the device using a UTF-8 key.
Definition FLImagingDevices/AutoFileCleaner.h:19