|
ifw-ccf
1.0.0
|
CCF Com. Int. implementing communication based on the Aravis open-source glib/gobject-based library for Genicam cameras. More...
#include <comAdptAravis.hpp>
Public Attributes | |
Various constants. | |
| const double | CONNECT_TIMEOUT = 10.0 |
| const double | FRAME_REC_THR_SLEEP_TIME = 0.0005 |
| const uint16_t | MAX_NB_OF_RECEP_BUFFERS = 100 |
| const uint16_t | NB_OF_INPUT_BUFFERS = 5 |
| const int32_t | DEFAULT_PACKET_SIZE = 1500 |
| const uint32_t | STREAM_BYTES_PER_SECOND_MIN = 1000000 |
| const uint32_t | STREAM_BYTES_PER_SECOND_MAX = 248000000 |
GigE Vision parameter names. | |
| const std::string | GIGE_PAR_ACQUISITION_ABORT = "AcquisitionAbort" |
| const std::string | GIGE_PAR_ACQUISITION_MODE = "AcquisitionMode" |
| const std::string | GIGE_PAR_ACQUISITION_START = "AcquisitionStart" |
| const std::string | GIGE_PAR_ACQUISITION_STOP = "AcquisitionStop" |
| const std::string | GIGE_PAR_DEVICE_VENDOR_NAME = "DeviceVendorName" |
| const std::string | GIGE_PAR_PACKET_SIZE = "PacketSize" |
| const std::string | GIGE_PAR_PAYLOAD_SIZE = "PayloadSize" |
| const std::string | GIGE_PAR_PIXELFORMAT = "PixelFormat" |
| const std::string | GIGE_PAR_SENSOR_BITS = "SensorBits" |
| const std::string | GIGE_PAR_SENSOR_HEIGHT = "SensorHeight" |
| const std::string | GIGE_PAR_SENSOR_TYPE = "SensorType" |
| const std::string | GIGE_PAR_SENSOR_WIDTH = "SensorWidth" |
| const std::string | GIGE_PAR_STREAM_BYTES_PER_SECOND = "StreamBytesPerSecond" |
| const std::string | GIGE_PAR_TIMESTAMP_TICK_FREQ = "TimestampTickFreq" |
| const std::string | GIGE_PAR_FRAME_TRIGGER_MODE = "FrameStartTriggerMode" |
| const std::string | GIGE_PAR_TRIGGER_MODE = "TriggerMode" |
| const std::string | GIGE_PAR_TRIGGER_SOURCE = "TriggerSource" |
| const std::map< int, std::string > | ARV_BUFFER_STATUS_STRING |
| ccf::common::ExpoMode | p_expo_mode |
| bool | p_exec_fr_acq_thr |
| bool | p_term_fr_acq_thr |
| int32_t | p_cur_buffer_index |
| ArvDevice * | p_device |
| ArvFrame | p_frame_buffers [100] |
| bool | p_frame_buffers_in_use [100] |
| uint32_t | p_frame_count |
| bool | p_ignore_frame_skipping |
| double | p_last_missing_data_log |
| int32_t | p_payload_size |
| std::map< ArvBufferStatus, std::string > | p_status_map |
| ArvStream * | p_stream |
| int32_t | p_acq_thr_buf_index |
| bool | p_waiting_for_frame |
| double | p_timestamp_frequency |
| std::thread * | p_fr_acq_thr |
| struct sched_param | p_fr_acq_thr_sched_par |
| std::string | m_vendor |
| int32_t | m_bytes_per_pixel |
| int32_t | m_sensor_height |
| int32_t | m_sensor_width |
| double | m_cur_expo_time |
| double | m_cur_expo_frame_rate |
| int32_t | m_cur_expo_bin_x |
| int32_t | m_cur_expo_bin_y |
| int32_t | m_cur_expo_win_start_x |
| int32_t | m_cur_expo_win_start_y |
| int32_t | m_cur_expo_win_width |
| int32_t | m_cur_expo_win_height |
| ComAdptAravis () | |
| virtual | ~ComAdptAravis () |
| virtual void | InitialiseUser () |
| virtual void | CheckConnectionUser (bool &connected) |
| virtual void | CheckStatusUser (ccf::common::HwStatus &status, std::string &message) |
| virtual void | ConnectUser () |
| virtual void | DisconnectUser () |
| virtual bool | IsConnectedUser () const |
| virtual void | ReadUser (const std::string &name, ctd::param::Parameter &par) |
| virtual void | ReceiveUser (ccf::common::DataFrame &frame, bool &frame_received, const double timeout, bool &timed_out) |
| virtual void | ScanUser (std::vector< ctd::param::Parameter > &pars) |
| virtual void | StartUser () |
| virtual void | StopUser () |
| virtual void | WriteUser (const ctd::param::Parameter &par) |
| virtual double | GetTheoreticFrameRateUser () |
| virtual void | _AdjustStreamBytesPerSecHook () |
| virtual int8_t | _ReadBasicParsHook () |
| virtual int8_t | _WriteParHook (ctd::param::Parameter &par, bool &ignore_unknown) |
| bool | GetAcqThrExecFlag () |
| void | _Reset () |
| void | _ClearCamHandle () |
Additional Inherited Members | |
Public Member Functions inherited from ccf::common::ComAdptBase | |
| ComAdptBase () | |
| virtual | ~ComAdptBase () |
| ccf::common::ConfigBase & | Cfg () |
| Return reference to general configuration object (singleton). More... | |
| const std::string & | GetCameraAddress () const |
| Return the address of the camera from the configuration. More... | |
| const std::string & | GetId () const |
| Get the ID of the associated camera. More... | |
| void | SetHostAdddress (const std::string &host_address) |
| Set the address of the host (network interface) used for communicating with the camera. More... | |
| const std::string & | GetHostAddress () |
| Return the address of the host (network interface) used for communicating with the camera. More... | |
| void | SetIsSimAdapter (const bool is_sim) |
| Set the Simulation Adapter Flag. More... | |
| bool | GetIsSimAdapter () const |
| Return the Simulation Adapter Flag. More... | |
| void | SetProtocol (const std::string &protocol) |
| Set the communication protocol used. More... | |
| const std::string & | GetProtocol () const |
| Return the communication protocol used. More... | |
| template<class TYPE > | |
| TYPE | GetCameraProperty (const std::string &property) |
| bool | HasCameraProperty (const std::string &property, std::string &value) |
| double | GetTheoreticFrameRate () |
| Render the theoritic, possible achievable frame rate (frame/s). More... | |
| void | LoadCameraNameMapping (const std::string &name_mapping_file) |
| void | Initialise (const bool re_init=false) |
| void | SetCameraAddress (const std::string &address) |
| Set the internal address, e.g. URI, used for communicating with the camera. More... | |
| void | CheckConnection (bool &connected) |
| Check if the connection to the camera is OK. More... | |
| void | CheckStatus (ccf::common::HwStatus &status, std::string &message) |
| Check the status of the camera (health status). More... | |
| bool | IsConnected () const |
| Returns true if the connection to the camera is established and valid. More... | |
| void | Connect () |
| void | Disconnect () |
| Disconnect from the camera. More... | |
| void | WriteAdapterProps () |
| virtual void | WriteAdapterPropsUser () |
| void | SetIsConnected (const bool connected) |
| bool | GetAllowLostFrames () const |
| Return flag (cfg par) indicating if lost frames shall be ignored silently. More... | |
| uint64_t | IncLostFramesCount () |
| Increment the counter of lost frames. The new value is returned. More... | |
| uint64_t | GetLostFramesCount () const |
| Return the number of lost frames currently registered. More... | |
| void | ResetLostFramesCount () |
| Reset the lost frames counter. More... | |
| void | Read (const std::string &name, ctd::param::Parameter &par) |
| void | Read (const std::vector< std::string > &names, std::vector< ctd::param::Parameter > &pars) |
| std::string | Read (const std::string &name) |
| template<class TYPE > | |
| TYPE | Read (const std::string &name) |
| Template method to read a parameter, taking care of the conversion to the desired user representation. More... | |
| void | Write (const ctd::param::Parameter &par) |
| void | Write (const std::vector< ctd::param::Parameter > &pars) |
| template<class TYPE > | |
| void | Write (const std::string &name, const TYPE &value) |
| Template method to write a parameter, taking care of converting the user data into the internal type. More... | |
| void | Receive (ccf::common::DataFrame &frame, bool &frame_received, const double timeout, bool &timed_out) |
| void | Scan (std::vector< ctd::param::Parameter > &pars) |
| Scan the address of the associated camera and store the parameters in the vector. More... | |
| void | Start () |
| Start the image acquisition in the camera. More... | |
| void | Stop () |
| Stop the image acquisition in the camera. More... | |
| void | HandleSetup () |
| void | HandleParPreWrite (ctd::param::Parameter &par) |
| void | HandleParPostWrite (ctd::param::Parameter &par) |
| Invoked after writing to the camera in case additional processing and downloading of parameters is needed. More... | |
| void | HandleParPostRead (ctd::param::Parameter &par) |
| Invoked before reading a parameter from the camera, in case speciel handling is needed. More... | |
| void | MapParForDevice (ctd::param::Parameter &par) const |
| void | MapParFromDevice (ctd::param::Parameter &par) const |
| bool | HasNameMapping (const std::string &name) const |
| Return true if a mapping is defined in the Camera Name Mapping for the given name. More... | |
| virtual void | SetCameraAddressUser (const std::string &address) |
| virtual bool | HasCameraPropertyUser (const std::string &property, std::string &value) |
| virtual void | ReadUser (const std::vector< std::string > &names, std::vector< ctd::param::Parameter > &pars) |
| virtual void | WriteUser (const std::vector< ctd::param::Parameter > &pars) |
| virtual void | HandleSetupUser () |
| virtual void | HandleParPreWriteUser (ctd::param::Parameter &par) |
| virtual void | HandleParPostWriteUser (ctd::param::Parameter &par) |
| virtual void | HandleParPostReadUser (ctd::param::Parameter &par) |
Public Member Functions inherited from ccf::common::Base | |
| Base () | |
| ~Base () | |
| const std::string & | GetClassName () const |
| Return the allocated name of the class. More... | |
Static Public Member Functions inherited from ccf::common::Base | |
| static ccf::mptk::Manager & | Mptk () |
| Return reference to internal MPTK instance (singleton). More... | |
| static void | SetLogLevel (const ccf::common::LogLevel log_level) |
| Set the log level. More... | |
| static ccf::common::LogLevel | GetLogLevel () |
| Return the current CCF log level. More... | |
Protected Member Functions inherited from ccf::common::Base | |
| void | SetClassName (const std::string &class_name) |
| Set the name of the class in question. More... | |
Protected Attributes inherited from ccf::common::ComAdptBase | |
| bool | m_is_connected |
CCF Com. Int. implementing communication based on the Aravis open-source glib/gobject-based library for Genicam cameras.
Implements ccf::common::ComAdptBase.
| ccf::protocols::aravis::ComAdptAravis::ComAdptAravis | ( | ) |
|
virtual |
|
virtual |
|
protected |
|
virtual |
|
protected |
|
virtual |
|
virtual |
Specific implementation of the connection check algorithm. See also "CheckConnection()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the status check algorithm. See also "CheckStatus()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the connection algorithm to connect to the camera. See also "Connect()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the algorithm to disconnect from the camera. See also "Disconnect()".
Reimplemented from ccf::common::ComAdptBase.
| bool ccf::protocols::aravis::ComAdptAravis::GetAcqThrExecFlag | ( | ) |
|
virtual |
Specific implementation of the algorithm to estimate the theoretic frame rate. Need normally not to be provided for specific Communication Adapters. See also "GetTheoreticFrameRate()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the adapter/camera initialisation. See also "Initialise()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the algorithm to determine if a connection to the camera is established. See also "IsConnected()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the reading of single parameter from the camera. See also "Read(single)".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the frame reception. See also "Receive()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the scanning of the defined parameters in the camera namespace. See also "Scan()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the algorithm to start the image acquisition in the camera. See also "Start()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the algorithm to stop the image acquisition in the camera. See also "Stop()".
Reimplemented from ccf::common::ComAdptBase.
|
virtual |
Specific implementation of the algorithm to write single parameters to the camera. See also "Write(single)".
Reimplemented from ccf::common::ComAdptBase.
| const std::map<int, std::string> ccf::protocols::aravis::ComAdptAravis::ARV_BUFFER_STATUS_STRING |
| const double ccf::protocols::aravis::ComAdptAravis::CONNECT_TIMEOUT = 10.0 |
| const int32_t ccf::protocols::aravis::ComAdptAravis::DEFAULT_PACKET_SIZE = 1500 |
| const double ccf::protocols::aravis::ComAdptAravis::FRAME_REC_THR_SLEEP_TIME = 0.0005 |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_ACQUISITION_ABORT = "AcquisitionAbort" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_ACQUISITION_MODE = "AcquisitionMode" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_ACQUISITION_START = "AcquisitionStart" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_ACQUISITION_STOP = "AcquisitionStop" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_DEVICE_VENDOR_NAME = "DeviceVendorName" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_FRAME_TRIGGER_MODE = "FrameStartTriggerMode" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_PACKET_SIZE = "PacketSize" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_PAYLOAD_SIZE = "PayloadSize" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_PIXELFORMAT = "PixelFormat" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_SENSOR_BITS = "SensorBits" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_SENSOR_HEIGHT = "SensorHeight" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_SENSOR_TYPE = "SensorType" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_SENSOR_WIDTH = "SensorWidth" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_STREAM_BYTES_PER_SECOND = "StreamBytesPerSecond" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_TIMESTAMP_TICK_FREQ = "TimestampTickFreq" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_TRIGGER_MODE = "TriggerMode" |
| const std::string ccf::protocols::aravis::ComAdptAravis::GIGE_PAR_TRIGGER_SOURCE = "TriggerSource" |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
| const uint16_t ccf::protocols::aravis::ComAdptAravis::MAX_NB_OF_RECEP_BUFFERS = 100 |
| const uint16_t ccf::protocols::aravis::ComAdptAravis::NB_OF_INPUT_BUFFERS = 5 |
| int32_t ccf::protocols::aravis::ComAdptAravis::p_acq_thr_buf_index |
| int32_t ccf::protocols::aravis::ComAdptAravis::p_cur_buffer_index |
| ArvDevice* ccf::protocols::aravis::ComAdptAravis::p_device |
| bool ccf::protocols::aravis::ComAdptAravis::p_exec_fr_acq_thr |
| ccf::common::ExpoMode ccf::protocols::aravis::ComAdptAravis::p_expo_mode |
| std::thread* ccf::protocols::aravis::ComAdptAravis::p_fr_acq_thr |
| struct sched_param ccf::protocols::aravis::ComAdptAravis::p_fr_acq_thr_sched_par |
| ArvFrame ccf::protocols::aravis::ComAdptAravis::p_frame_buffers[100] |
| bool ccf::protocols::aravis::ComAdptAravis::p_frame_buffers_in_use[100] |
| uint32_t ccf::protocols::aravis::ComAdptAravis::p_frame_count |
| bool ccf::protocols::aravis::ComAdptAravis::p_ignore_frame_skipping |
| double ccf::protocols::aravis::ComAdptAravis::p_last_missing_data_log |
| int32_t ccf::protocols::aravis::ComAdptAravis::p_payload_size |
| std::map<ArvBufferStatus, std::string> ccf::protocols::aravis::ComAdptAravis::p_status_map |
| ArvStream* ccf::protocols::aravis::ComAdptAravis::p_stream |
| bool ccf::protocols::aravis::ComAdptAravis::p_term_fr_acq_thr |
| double ccf::protocols::aravis::ComAdptAravis::p_timestamp_frequency |
| bool ccf::protocols::aravis::ComAdptAravis::p_waiting_for_frame |
| const uint32_t ccf::protocols::aravis::ComAdptAravis::STREAM_BYTES_PER_SECOND_MAX = 248000000 |
| const uint32_t ccf::protocols::aravis::ComAdptAravis::STREAM_BYTES_PER_SECOND_MIN = 1000000 |