FLImaging 7.8.25.3
DeviceCameraMatrox.h
1#pragma once
9
10#include "DeviceCameraBase.h"
11#include "DeviceCameraFeatureBase.h"
12
13
15namespace FLImaging
16{
18 namespace Devices
19 {
20 class CInternalDeviceCameraMatrox;
21
30 {
31 public:
32
41 {
46
51
56
61
66
71
76
81
86
91
96
101
106
111
116
121 };
122
131 {
136
141
146
151
156
161
166
171
176
181
186
191
196
201
206
211
216
221
226
231
236
241
246
251
256
261
266
271
276
281
286
291
296
301
306
311
316
321
326
331
336
341
346
351
356
361
366
371 };
372
373 public:
381
389
390 virtual const CResult Initialize() override;
391 virtual const CResult Terminate() override;
392
393 virtual const CResult Grab() override;
394 virtual const CResult Live() override;
395 virtual const CResult Stop() override;
396
397 virtual const CResult TriggerWithSoftware() override;
398
414 virtual const CResult SetDeviceType(EDeviceType eType);
415
427 virtual EDeviceType GetDeviceType() const;
428
442 virtual const CResult SetDeviceIndex(int32_t i32DeviceIndex);
443
453 virtual int32_t GetDeviceIndex() const;
454
468 virtual const CResult SetModuleIndex(int32_t i32ModuleIndex);
469
479 virtual int32_t GetModuleIndex() const;
480
496 virtual const CResult SetCamFilePath(const Base::CFLString<wchar_t>& flsCamFilePath);
497
510
511
512
526 virtual const CResult SetExposureTime(double f64Exposure);
527
541 virtual const CResult GetExposureTime(double* pF64Exposure) const;
542
556 virtual const CResult GetExposureTime(double& f64Exposure) const;
557
571 virtual const CResult SetGain(int64_t i64Gain);
572
586 virtual const CResult GetGain(int64_t* pI64Gain) const;
587
601 virtual const CResult GetGain(int64_t& i64Gain) const;
602
603
617 virtual const CResult SetTriggerMode(bool bOn);
618
632 virtual const CResult GetTriggerMode(bool* pOn) const;
633
647 virtual const CResult GetTriggerMode(bool& bOn) const;
648
665
681 virtual const CResult GetTriggerSource(ETriggerSource* pSource) const;
682
698 virtual const CResult GetTriggerSource(ETriggerSource& eSource) const;
699
701 virtual const CResult SetBoolValue(const char* pszKey, const bool* pBValue) override;
702 virtual const CResult SetBoolValue(const wchar_t* pWcsKey, const bool* pBValue) override;
703
705 virtual const CResult GetBoolValue(const char* pszKey, bool* pBValue) const override;
706 virtual const CResult GetBoolValue(const wchar_t* pWcsKey, bool* pBValue) const override;
707
709 virtual const CResult SetInt32Value(const char* pszKey, const int32_t* pI32Value) override;
710
712 virtual const CResult GetInt32Value(const char* pszKey, int32_t* pI32Value) const override;
713
715 virtual const CResult SetInt64Value(const char* pszKey, const int64_t* pI64Value) override;
716 virtual const CResult SetInt64Value(const wchar_t* pWcsKey, const int64_t* pI64Value) override;
717
719 virtual const CResult GetInt64Value(const char* pszKey, int64_t* pI64Value) const override;
720 virtual const CResult GetInt64Value(const wchar_t* pWcsKey, int64_t* pI64Value) const override;
721
723 virtual const CResult SetFloatValue(const char* pszKey, const float* pF32Value) override;
724
726 virtual const CResult GetFloatValue(const char* pszKey, float* pF32Value) const override;
727
729 virtual const CResult SetDoubleValue(const char* pszKey, const double* pF64Value) override;
730 virtual const CResult SetDoubleValue(const wchar_t* pWcsKey, const double* pF64Value) override;
731
733 virtual const CResult GetDoubleValue(const char* pszKey, double* pF64Value) const override;
734 virtual const CResult GetDoubleValue(const wchar_t* pWcsKey, double* pF64Value) const override;
735
737 virtual const CResult SetStringValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
738 virtual const CResult SetStringValue(const wchar_t* pWcsKey, const Base::CFLString<wchar_t>* pFlsValue) override;
739
741 virtual const CResult GetStringValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
742 virtual const CResult GetStringValue(const wchar_t* pWcsKey, Base::CFLString<wchar_t>* pFlsValue) const override;
743
744 DeclareGetClassType();
745
746 protected:
747 virtual bool CheckDeviceLibraries() const override;
748
749 virtual const CResult AllocApp();
750 virtual const CResult DeallocApp();
751
752 virtual const CResult AllocSystem();
753 virtual const CResult DeallocSystem();
754
755 private:
757 virtual const CResult SetEnumValue(const char* pszKey, const int32_t* pI32Value) override;
758 virtual const CResult SetEnumValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
759
761 virtual const CResult GetEnumValue(const char* pszKey, int32_t* pI32Value) const override;
762 virtual const CResult GetEnumValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
763
765 virtual const CResult GetEnumFeatureEntries(const Base::CFLString<wchar_t>& flsFeature, std::vector<std::pair<int32_t, Base::CFLString<wchar_t>>>* pVctEntries) const override;
766
768 virtual const CResult ExecuteCommand(const char* pszKey) const override;
769
770
771 protected:
772 CInternalDeviceCameraMatrox* m_pInternal;
773
774 friend class CInternalDeviceCameraMatrox;
775 };
776 }
777}
778
779
Template type string class.
Definition FLString.h:34
FLImaging module execution result object.
Definition ResultsDef.h:1704
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 DeviceCameraMatrox.h:41
@ EDeviceType_Indio
MIL Indio system.
Definition DeviceCameraMatrox.h:80
@ EDeviceType_ClarityUHD
MIL Clarity UHD system.
Definition DeviceCameraMatrox.h:50
@ EDeviceType_GevIQ
MIL GevIQ system.
Definition DeviceCameraMatrox.h:65
@ EDeviceType_ConcordPOE
MIL Concord POE system.
Definition DeviceCameraMatrox.h:55
@ EDeviceType_RapixoCXP
Rapixo CXP system.
Definition DeviceCameraMatrox.h:110
@ EDeviceType_IrisGTX
Iris GTX system.
Definition DeviceCameraMatrox.h:85
@ EDeviceType_Solios
Solios system.
Definition DeviceCameraMatrox.h:115
@ EDeviceType_GigE
MIL GigE Vision system.
Definition DeviceCameraMatrox.h:70
@ EDeviceType_GenTL
MIL GenTL system.
Definition DeviceCameraMatrox.h:60
@ EDeviceType_Host
Host.
Definition DeviceCameraMatrox.h:75
@ EDeviceType_Morphis
Morphis system.
Definition DeviceCameraMatrox.h:90
@ EDeviceType_USB3
USB3 Vision system.
Definition DeviceCameraMatrox.h:120
@ EDeviceType_Radient_eV_CL
Radient eV-CL system.
Definition DeviceCameraMatrox.h:100
@ EDeviceType_RapixoProCL
Rapixo Pro CL system.
Definition DeviceCameraMatrox.h:105
@ EDeviceType_Radient_eV_CXP
Radient eV-CXP system.
Definition DeviceCameraMatrox.h:95
@ EDeviceType_Unknown
Unknown type.
Definition DeviceCameraMatrox.h:45
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 DeviceCameraMatrox.h:131
@ ETriggerSource_Null
No trigger source.
Definition DeviceCameraMatrox.h:140
@ ETriggerSource_AuxIO14
Auxiliary input signal 14.
Definition DeviceCameraMatrox.h:285
@ ETriggerSource_Timer1
Timer 1.
Definition DeviceCameraMatrox.h:195
@ ETriggerSource_AuxIO27
Auxiliary input signal 27.
Definition DeviceCameraMatrox.h:350
@ ETriggerSource_RotaryEncoder3
Rotary decoder 3.
Definition DeviceCameraMatrox.h:185
@ ETriggerSource_Timer2
Timer 2.
Definition DeviceCameraMatrox.h:200
@ ETriggerSource_AuxIO4
Auxiliary input signal 4.
Definition DeviceCameraMatrox.h:235
@ ETriggerSource_AuxIO29
Auxiliary input signal 29.
Definition DeviceCameraMatrox.h:360
@ ETriggerSource_RotaryEncoder1
Rotary decoder 1.
Definition DeviceCameraMatrox.h:175
@ ETriggerSource_AuxIO2
Auxiliary input signal 2.
Definition DeviceCameraMatrox.h:225
@ ETriggerSource_AuxIO13
Auxiliary input signal 13.
Definition DeviceCameraMatrox.h:280
@ ETriggerSource_AuxIO15
Auxiliary input signal 15.
Definition DeviceCameraMatrox.h:290
@ ETriggerSource_AuxIO28
Auxiliary input signal 28.
Definition DeviceCameraMatrox.h:355
@ ETriggerSource_AuxIO25
Auxiliary input signal 25.
Definition DeviceCameraMatrox.h:340
@ ETriggerSource_AuxIO31
Auxiliary input signal 31.
Definition DeviceCameraMatrox.h:370
@ ETriggerSource_AuxIO9
Auxiliary input signal 9.
Definition DeviceCameraMatrox.h:260
@ ETriggerSource_AuxIO12
Auxiliary input signal 12.
Definition DeviceCameraMatrox.h:275
@ ETriggerSource_AuxIO5
Auxiliary input signal 5.
Definition DeviceCameraMatrox.h:240
@ ETriggerSource_RotaryEncoder
Default rotary decoder.
Definition DeviceCameraMatrox.h:170
@ ETriggerSource_AuxIO21
Auxiliary input signal 21.
Definition DeviceCameraMatrox.h:320
@ ETriggerSource_AuxIO17
Auxiliary input signal 17.
Definition DeviceCameraMatrox.h:300
@ ETriggerSource_AuxIO16
Auxiliary input signal 16.
Definition DeviceCameraMatrox.h:295
@ ETriggerSource_Software3
Software trigger being used for the grab of another digitizer 3.
Definition DeviceCameraMatrox.h:160
@ ETriggerSource_AuxIO26
Auxiliary input signal 26.
Definition DeviceCameraMatrox.h:345
@ ETriggerSource_AuxIO22
Auxiliary input signal 22.
Definition DeviceCameraMatrox.h:325
@ ETriggerSource_AuxIO23
Auxiliary input signal 23.
Definition DeviceCameraMatrox.h:330
@ ETriggerSource_Software1
Software trigger being used for the grab of another digitizer 1.
Definition DeviceCameraMatrox.h:150
@ ETriggerSource_AuxIO6
Auxiliary input signal 6.
Definition DeviceCameraMatrox.h:245
@ ETriggerSource_AuxIO0
Auxiliary input signal 0.
Definition DeviceCameraMatrox.h:215
@ ETriggerSource_AuxIO30
Auxiliary input signal 30.
Definition DeviceCameraMatrox.h:365
@ ETriggerSource_Default
Specified by the DCF.
Definition DeviceCameraMatrox.h:135
@ ETriggerSource_Software
Software.
Definition DeviceCameraMatrox.h:145
@ ETriggerSource_AuxIO24
Auxiliary input signal 24.
Definition DeviceCameraMatrox.h:335
@ ETriggerSource_RotaryEncoder4
Rotary decoder 4.
Definition DeviceCameraMatrox.h:190
@ ETriggerSource_AuxIO11
Auxiliary input signal 11.
Definition DeviceCameraMatrox.h:270
@ ETriggerSource_AuxIO10
Auxiliary input signal 10.
Definition DeviceCameraMatrox.h:265
@ ETriggerSource_Timer4
Timer 4.
Definition DeviceCameraMatrox.h:210
@ ETriggerSource_Software2
Software trigger being used for the grab of another digitizer 2.
Definition DeviceCameraMatrox.h:155
@ ETriggerSource_AuxIO7
Auxiliary input signal 7.
Definition DeviceCameraMatrox.h:250
@ ETriggerSource_Timer3
Timer 3.
Definition DeviceCameraMatrox.h:205
@ ETriggerSource_AuxIO19
Auxiliary input signal 19.
Definition DeviceCameraMatrox.h:310
@ ETriggerSource_AuxIO8
Auxiliary input signal 8.
Definition DeviceCameraMatrox.h:255
@ ETriggerSource_RotaryEncoder2
Rotary decoder 2.
Definition DeviceCameraMatrox.h:180
@ ETriggerSource_AuxIO3
Auxiliary input signal 3.
Definition DeviceCameraMatrox.h:230
@ ETriggerSource_AuxIO20
Auxiliary input signal 20.
Definition DeviceCameraMatrox.h:315
@ ETriggerSource_AuxIO18
Auxiliary input signal 18.
Definition DeviceCameraMatrox.h:305
@ ETriggerSource_Software4
Software trigger being used for the grab of another digitizer 4.
Definition DeviceCameraMatrox.h:165
@ ETriggerSource_AuxIO1
Auxiliary input signal 1.
Definition DeviceCameraMatrox.h:220
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 AutoFileCleaner.h:19